Package de.elo.client.scripting.items

Class StructureElement

Object

IndexedElement

ArchiveElement

StructureElement

public class StructureElement
extends ArchiveElement

Überschrift: StructureElement

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

Copyright: Copyright (c) ELO Digital Office GmbH 2007-2014

Constructor Summary

Constructors

Constructor	Description
StructureElement(Workspace workspace, int objId)	Interner Konstruktor.
StructureElement(Workspace workspace, Sord sord)	Interner Konstruktor.

Method Summary

Modifier and Type	Method	Description
void	addCopy(int sourceId, boolean includeDocuments, boolean copyNotes, boolean copyReferences, boolean copyOwner, String endEvent)	Fügt eine Kopie von Archiveinträgen in diesen Ordner ein.
void	addCopy(int sourceId, boolean includeDocuments, boolean copyNotes, boolean copyReferences, boolean copyOwner, String endEvent, boolean copyAllVersions, boolean copyAllFileAttachments, boolean copyAllFileAttachVersions)	Fügt eine Kopie von Archiveinträgen in diesen Ordner ein.
void	addCopy(int sourceId, boolean includeDocuments, boolean copyNotes, boolean copyReferences, boolean copyOwner, String endEvent, boolean copyAllVersions, boolean copyAllFileAttachments, boolean copyAllFileAttachVersions, boolean takeTargetPermissions)	Fügt eine Kopie von Archiveinträgen in diesen Ordner ein.
ArchiveDocument	addDocument(Sord documentSord, String fileName)	Fügt das im Sord Dokument in die Struktur ein.
int	addPath(String path, 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(Sord newSord)	Fügt das Sord als neues Strukturelement in dieses Strukturelement hinzu.
StructureElement	addStructure(String name)	Erzeugt ein untergeordnetes Strukturelement mit dem angegebenen Namen in diesem Strukturelement.
ArchiveElement	childSelection(String title, String message)	Öffnet einen Auswahldialog für Unterlemente dieses Ordners.
Sord	createStructure()	Erzeugt ein neues Strukturelement.
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.
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.
Sord	prepareDocument(String maskIdOrName)	Bereitet ein Sord-Objekt für eine neues Dokument vor.
Sord	prepareSord(String maskIdOrName)	Deprecated. Ersetzt durch prepareStructure(String) und prepareDocument(String) bei denen der Objekt-Typ festgelegt ist.
Sord	prepareStructure(String maskIdOrName)	Bereitet ein Sord-Objekt für eine neue Struktur vor.
void	refreshChildren()	Aktualisert die Untereinträge des Ordners.

Methods inherited from class ArchiveElement

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

Methods inherited from class IndexedElement

getDocMask, getDocMaskId, getDocMaskName, getHiddenText, getMainScale, getName, getObjKeyValue, getObjKeyValue, getProperties, getReadableFileSize, getSord, saveSord, setHiddenText, setMainScale, setMaskId, setMaskIdWithDefaults, setName, setObjKeyValue, setObjKeyValue, setProperties

Methods inherited from class Object

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

Constructor Detail

StructureElement

public StructureElement(Workspace workspace,
                        int objId)

Interner Konstruktor.

Parameters:

workspace - Aktueller Arbeitsbereich

objId - Objekt Id der Struktur

StructureElement

public StructureElement(Workspace workspace,
                        Sord sord)

Interner Konstruktor.

Parameters:

workspace - Aktueller Arbeitsbereich

sord - Sord mit mbAll

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 Sord createStructure()
                     throws Exception

Erzeugt ein neues Strukturelement.

Returns:

Sord Verschlagwortungsinformation des neuen Strukturelements

Throws:

Exception - Wenn das Strukturelement nicht erzeugt werden konnte.

addPath

public int addPath(String path,
                   String folderMask)
            throws 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:

Exception - Wenn der Pfad nicht angelegt werden konnte.

Since:

8.01.000

prepareSord

@Deprecated
public Sord prepareSord(String maskIdOrName)
                 throws Exception

Deprecated.

Ersetzt durch prepareStructure(String) und prepareDocument(String) bei denen der Objekt-Typ festgelegt ist.

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

Parameters:

maskIdOrName - Nummer oder Name der Verschlagwortungsmaske

Returns:

das vorbereitete Sord-Objekt

Throws:

Exception - Wenn die Maske nicht gelesen werden kann oder das Objekt nicht angelegt werden konnte.

Since:

6.00.088

prepareStructure

public Sord prepareStructure(String maskIdOrName)
                      throws Exception

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

Parameters:

maskIdOrName - Nummer oder Name der Verschlagwortungsmaske

Returns:

Sord Das vorbereitete Sord-Objekt

Throws:

Exception - Wenn die Maske nicht gelesen werden kann oder das Objekt nicht angelegt werden konnte.

Since:

7.00.000

prepareDocument

public Sord prepareDocument(String maskIdOrName)
                     throws Exception

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

Parameters:

maskIdOrName - Nummer oder Name der Verschlagwortungsmaske

Returns:

Sord Das vorbereitete Sord-Objekt

Throws:

Exception - Wenn die Maske nicht gelesen werden kann oder das Objekt nicht angelegt werden konnte.

Since:

7.00.000

addDocument

public ArchiveDocument addDocument(Sord documentSord,
                                   String fileName)
                            throws 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. Ein leerer String ist möglich um einen Dokument-Eintrag ohne Dokumentdatei zu erstellen.

Returns:

ArchiveDocument das neu erzeugte Dokument im Archiv

Throws:

Exception - Wenn das Objekt nicht angelegt werden konnte.

Since:

6.00.088, ab 8.01.004 auch ohne Dokumentdatei möglich

addStructure

public StructureElement addStructure(Sord newSord)
                              throws Exception

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

Parameters:

newSord - Archivelement

Returns:

StructureElement Das angelegte Strukturelement

Throws:

Exception - Wenn das Objekt nicht angelegt werden konnte.

addStructure

public StructureElement addStructure(String name)
                              throws Exception

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

Parameters:

name - Bezeichnung des untergeordneten Strukturelementes

Returns:

StructureElement das angelegte Strukturelement

Throws:

Exception - Wenn das Objekt nicht angelegt werden konnte.

addReference

public void addReference(ArchiveElement sourceElement)
                  throws Exception

Erzeugt eine Referenz des angegebenen Elements in dieser Struktur.

Parameters:

sourceElement - Archivelement

Throws:

Exception - Wenn die Referenz nicht angelegt werden konnte.

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 Enumeration<ArchiveElement> getChildren()

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

Returns:

Aufzählung mit Unterelementen

getChildrenList

public ArrayList<ArchiveElement> getChildrenList()

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

Returns:

Liste mit Unterelementen

Since:

8.01.000

refreshChildren

public void refreshChildren()

Aktualisert die Untereinträge des Ordners. Diese werden dazu neu vom Server geladen und die Darstellung in allen Bereichen des Client aktualisiert.

Since:

8.03.000

addCopy

public void addCopy(int sourceId,
                    boolean includeDocuments,
                    boolean copyNotes,
                    boolean copyReferences,
                    boolean copyOwner,
                    String endEvent)
             throws 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. Als Parameter wird die Id des neuen Objektes übergeben.

Throws:

Exception - Wenn das Objekt nicht kopiert werden konnte.

Since:

8.01.000, 9.03.018, 10.01: endEvent wird mit einem Parameter "newId" aufgerufen.

addCopy

public void addCopy(int sourceId,
                    boolean includeDocuments,
                    boolean copyNotes,
                    boolean copyReferences,
                    boolean copyOwner,
                    String endEvent,
                    boolean copyAllVersions,
                    boolean copyAllFileAttachments,
                    boolean copyAllFileAttachVersions)
             throws 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. Als Parameter wird die Id des neuen Objektes übergeben.

copyAllVersions - Alle Dokumentversionen kopieren

copyAllFileAttachments - Dateianbindung kopieren

copyAllFileAttachVersions - Alle Versionen der Dateianbindung kopieren

Throws:

Exception - Wenn das Objekt nicht kopiert werden konnte.

Since:

8.05.000, 9.03.018, 10.01: endEvent wird mit einem Parameter "newId" aufgerufen.

addCopy

public void addCopy(int sourceId,
                    boolean includeDocuments,
                    boolean copyNotes,
                    boolean copyReferences,
                    boolean copyOwner,
                    String endEvent,
                    boolean copyAllVersions,
                    boolean copyAllFileAttachments,
                    boolean copyAllFileAttachVersions,
                    boolean takeTargetPermissions)
             throws 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. Als Parameter wird die Id des neuen Objektes übergeben.

copyAllVersions - Alle Dokumentversionen kopieren

copyAllFileAttachments - Dateianbindung kopieren

copyAllFileAttachVersions - Alle Versionen der Dateianbindung kopieren

takeTargetPermissions - Aktuelle Berechtigungen durch die Berechtigungen des Zielordners ersetzen

Throws:

Exception - Wenn das Objekt nicht kopiert werden konnte.

Since:

9.01.000, 9.03.018, 10.01: endEvent wird mit einem Parameter "newId" aufgerufen.

childSelection

public ArchiveElement childSelection(String title,
                                     String message)
                              throws Exception

Öffnet einen Auswahldialog für Unterlemente dieses Ordners.

Parameters:

title - Dialogtitel

message - Dialogtext

Returns:

Ausgewähler Archiveintrag oder null.

Throws:

Exception - Wenn der Dialog nicht angezeigt werden kann.

Since:

9.03.000