de.elo.client.scripting.items
Class StructureElement

java.lang.Object
  de.elo.client.scripting.items.IndexedElement
      de.elo.client.scripting.items.ArchiveElement
          de.elo.client.scripting.items.StructureElement

public class StructureElement
extends ArchiveElement

Überschrift: StructureElement

Beschreibung: Ein Strukturelement im Archiv (Schrank, Ordner, Register...)

Copyright: Copyright (c) ELO Digital Office GmbH 2007-2009, 2011

Constructor Summary

StructureElement(de.elo.client.maindialog.Workspace workspace, int objId)
Normaler Konstruktor.

Method Summary

void	addCopy(int sourceId, boolean includeDocuments, boolean copyNotes, boolean copyReferences, boolean copyOwner, java.lang.String endEvent) Fügt eine Kopie von Archiveinträgen in diesen Ordner ein.
ArchiveDocument	addDocument(de.elo.ix.client.Sord documentSord, java.lang.String fileName) Fügt das im Sord Dokument in die Struktur ein.
int	addPath(java.lang.String path, java.lang.String folderMask) Erzeugt in dem Element eine Unterstruktur falls sie nicht bereits vorhanden ist.
void	addReference(ArchiveElement sourceElement) Erzeugt eine Referenz des angegebenen Elements in dieser Struktur.
StructureElement	addStructure(de.elo.ix.client.Sord sord) Fügt das Sord als neues Strukturelement in dieses Strukturelement hinzu.
StructureElement	addStructure(java.lang.String name) Erzeugt ein untergeordnetes Strukturelement mit dem angegebenen Namen in diesem Strukturelement.
de.elo.ix.client.Sord	createStructure() Erzeugt ein neues Strukturelement.
java.util.Enumeration<ArchiveElement>	getChildren() Liefert eine Aufzählung aller Einträge (als ArchiveElement-Objekte ArchiveDokument oder StructureElement) in diesem Ordner.
int	getChildrenCount() Liefert die Anzahl der Elemente in diesem Strukturelement.
java.util.ArrayList<ArchiveElement>	getChildrenList() Liefert eine Liste aller Einträge (als ArchiveElement-Objekte ArchiveDokument oder StructureElement) in diesem Ordner.
boolean	isDocument() Liefert true, wenn dieses Element ein Dokument ist.
boolean	isStructure() Liefert true, wenn dieses Element ein Ordner ist.
de.elo.ix.client.Sord	prepareDocument(java.lang.String maskIdOrName) Bereitet ein Sord-Objekt für eine neues Dokument vor.
de.elo.ix.client.Sord	prepareSord(java.lang.String maskIdOrName) Deprecated. Ersetzt durch prepareStructure und prepareDocument bei denen der Objekt-Typ festgelegt ist.
de.elo.ix.client.Sord	prepareStructure(java.lang.String maskIdOrName) Bereitet ein Sord-Objekt für eine neue Struktur vor.

Methods inherited from class de.elo.client.scripting.items.ArchiveElement

del, getEditInfo, getId, getParent, loadSord, moveToFolder, referenceIn, refresh, removeLock, setLock, setSord

Methods inherited from class de.elo.client.scripting.items.IndexedElement

getDocMaskId, getDocMaskName, getHiddenText, getName, getObjKeyValue, getObjKeyValue, getProperties, getSord, saveSord, setHiddenText, setMaskId, setName, setObjKeyValue, setObjKeyValue, setProperties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StructureElement

public StructureElement(de.elo.client.maindialog.Workspace workspace,
                        int objId)

Normaler Konstruktor.

Parameters:

workspace - Aktueller Arbeitsbereich

objId - Objekt Id der Struktur

Method Detail

isDocument

public boolean isDocument()

Description copied from class: ArchiveElement

Liefert true, wenn dieses Element ein Dokument ist.

Specified by:

isDocument in class ArchiveElement

Returns:

boolean

isStructure

public boolean isStructure()

Description copied from class: ArchiveElement

Liefert true, wenn dieses Element ein Ordner ist.

Specified by:

isStructure in class ArchiveElement

Returns:

boolean

createStructure

public de.elo.ix.client.Sord createStructure()
                                      throws java.lang.Exception

Erzeugt ein neues Strukturelement.

Returns:

Sord Verschlagwortungsinformation des neuen Strukturelements

Throws:

java.lang.Exception

addPath

public int addPath(java.lang.String path,
                   java.lang.String folderMask)
            throws java.lang.Exception

Erzeugt in dem Element eine Unterstruktur falls sie nicht bereits vorhanden ist.

Parameters:

path - Unterstruktur, erstes Zeichn ist Trennsymbol

folderMask - Maskenname oder Maskennummer

Returns:

ELO Objekt-Id des letzten Ordner der Struktur

Throws:

java.lang.Exception

Since:

8.01.000

prepareSord

@Deprecated
public de.elo.ix.client.Sord prepareSord(java.lang.String maskIdOrName)
                                  throws java.lang.Exception

Deprecated. Ersetzt durch prepareStructure und prepareDocument bei denen der Objekt-Typ festgelegt ist.

Bereitet ein Sord-Objekt für eine neue Struktur vor.

Parameters:

maskIdOrName - Nummer oder Name der Ablagemaske

Returns:

das vorbereitete Sord-Objekt

Throws:

java.lang.Exception

Since:

6.00.088

prepareStructure

public de.elo.ix.client.Sord prepareStructure(java.lang.String maskIdOrName)
                                       throws java.lang.Exception

Bereitet ein Sord-Objekt für eine neue Struktur vor.

Parameters:

maskIdOrName - Nummer oder Name der Ablagemaske

Returns:

Sord Das vorbereitete Sord-Objekt

Throws:

java.lang.Exception

Since:

7.00.000

prepareDocument

public de.elo.ix.client.Sord prepareDocument(java.lang.String maskIdOrName)
                                      throws java.lang.Exception

Bereitet ein Sord-Objekt für eine neues Dokument vor.

Parameters:

maskIdOrName - Nummer oder Name der Ablagemaske

Returns:

Sord Das vorbereitete Sord-Objekt

Throws:

java.lang.Exception

Since:

7.00.000

addDocument

public ArchiveDocument addDocument(de.elo.ix.client.Sord documentSord,
                                   java.lang.String fileName)
                            throws java.lang.Exception

Fügt das im Sord Dokument in die Struktur ein. Die per fileName angegebene Dokumentdatei wird in das Archiv kopiert. Ablagedatum wird automatisch belegt. Dateiname Kurzbezeichnung werden automatisch belegt, falls sie nicht im documentSord gesetzt sind.

Parameters:

documentSord - Archivelement

fileName - Der Dateiname (inklusive Pfad) der abzulegenden Dokument-Datei

Returns:

ArchiveDocument das neu erzeugte Dokument im Archiv

Throws:

java.lang.Exception

Since:

6.00.088

addStructure

public StructureElement addStructure(de.elo.ix.client.Sord sord)
                              throws java.lang.Exception

Fügt das Sord als neues Strukturelement in dieses Strukturelement hinzu.

Parameters:

sord - Archivelement

Returns:

StructureElement Das angelegte Strukturelement

Throws:

java.lang.Exception

addStructure

public StructureElement addStructure(java.lang.String name)
                              throws java.lang.Exception

Erzeugt ein untergeordnetes Strukturelement mit dem angegebenen Namen in diesem Strukturelement.

Parameters:

name - Bezeichnung des untergeordneten Strukturelementes

Returns:

StructureElement das angelegte Strukturelement

Throws:

java.lang.Exception

addReference

public void addReference(ArchiveElement sourceElement)
                  throws java.lang.Exception

Erzeugt eine Referenz des angegebenen Elements in dieser Struktur.

Parameters:

sourceElement - Archivelement

Throws:

java.lang.Exception

Since:

6.00.088

getChildrenCount

public int getChildrenCount()

Liefert die Anzahl der Elemente in diesem Strukturelement. Dies können sowohl Dokumente, als auch wiederrum Strukturelemente sein.

Returns:

Anzahl der Elemente in diesem Strukturelement

getChildren

public java.util.Enumeration<ArchiveElement> getChildren()

Liefert eine Aufzählung aller Einträge (als ArchiveElement-Objekte ArchiveDokument oder StructureElement) in diesem Ordner.

Returns:

Enumeration Aufzählung mit Unterelementen

getChildrenList

public java.util.ArrayList<ArchiveElement> getChildrenList()

Liefert eine Liste aller Einträge (als ArchiveElement-Objekte ArchiveDokument oder StructureElement) in diesem Ordner.

Returns:

Enumeration Liste mit Unterelementen

Since:

8.01.000

addCopy

public void addCopy(int sourceId,
                    boolean includeDocuments,
                    boolean copyNotes,
                    boolean copyReferences,
                    boolean copyOwner,
                    java.lang.String endEvent)
             throws java.lang.Exception

Fügt eine Kopie von Archiveinträgen in diesen Ordner ein. Die Quelle kann ein einzelnes Dokument oder ein Ordner sein. Es wird die Struktur in dem Ordner inklusive Unterordnern und (optional) Dokumenten kopiert. Das Kopieren findet asynchron auf dem Server statt.

Parameters:

sourceId - ObjektID der Quelle

includeDocuments - True wenn die Dokumente innerhalb der Ordnerstruktur ebenfalls kopiert werden sollen, False wenn nur die Ordnerstruktur kopiert werden soll.

copyNotes - True wenn die Anmerkungen zu den Dokumenten ebenfalls kopiert werden sollen, False wenn nicht.

copyReferences - True wenn die Referenzen kopiert werden sollen, False wenn nicht.

copyOwner - True wenn der Eigentümer der Ordner und Dokumente von der Quelle übernommen werden sollen, False wenn nicht.

endEvent - Ein Event, welches aufgerufen wird, wenn das Kopieren beendet wurde oder null für kein Event.

Throws:

java.lang.Exception

Since:

8.01.000