Package de.elo.client.scripting.items

Class ArchiveElement

Object

IndexedElement

ArchiveElement

Direct Known Subclasses:

ArchiveDocument, StructureElement

public abstract class ArchiveElement
extends IndexedElement

Überschrift: ArchiveElement

Beschreibung: Ein Element im Archiv (Dokument oder Ordner).

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

Constructor Summary

Constructors

Constructor	Description
ArchiveElement(Workspace workspace, int id)	Interner Konstruktor für die Klasse "ArchiveElement".
ArchiveElement(Workspace workspace, Sord sord)	Interner Konstruktor für die Klasse "ArchiveElement".

Method Summary

Modifier and Type	Method	Description
String	addFeedComment(String comment)	Erzeugt einen Feed-Kommentar Eintrag.
boolean	del()	Löscht das Element (und alle Referenzen darauf).
EditInfo	getEditInfo()	Liefert das zugehörige EditInfo-Objekt zurück.
int	getId()	Liefert die ObjektID des Archiveintrags zurück.
StructureElement	getParent()	Liefert den übergeordneten Ordner dieses Eintrags.
abstract boolean	isDocument()	Liefert true, wenn dieses Element ein Dokument ist.
boolean	isLocked()	Gibt an, ob der Archiveintrag gesperrt ist.
abstract boolean	isStructure()	Liefert true, wenn dieses Element ein Ordner ist.
Sord	loadSord()	Lädt die Verschlagwortungsinformationen(Sord) vom IndexServer.
boolean	moveToFolder(StructureElement targetFolder, boolean showErrorDialog)	Verschiebt diesen Archiveintrag in den angegebenen Zielordner.
boolean	moveToFolder(StructureElement targetFolder, boolean showErrorDialog, int currentParentId)	Verschiebt diesen Archiveintrag in den angegebenen Zielordner unter berücksichtigung von Referenzeinträgen.
boolean	referenceIn(StructureElement newParent)	Referenziert das aktuelle Archivelement in den angegebenen Ordner.
void	refresh()	Aktualisert den Archiveintrag.
void	removeLock()	Entfernt die Sperre vom Archiveintrag.
boolean	setLock()	Setzt eine Sperre auf den Archiveintrag.
void	setSord(Sord sord)	Setzt die Verschlagwortungsinformationen(Sord).

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

ArchiveElement

public ArchiveElement(Workspace workspace,
                      int id)

Interner Konstruktor für die Klasse "ArchiveElement".

Parameters:

workspace - Aktueller Arbeitsbereich

id - ObjektId des Archiveintrags

ArchiveElement

public ArchiveElement(Workspace workspace,
                      Sord sord)

Interner Konstruktor für die Klasse "ArchiveElement".

Parameters:

workspace - Aktueller Arbeitsbereich

sord - Sord mit mbAll

Method Detail

getId

public int getId()

Liefert die ObjektID des Archiveintrags zurück.

Returns:

ObjektId des Archiveintrags

loadSord

public Sord loadSord()
              throws Exception

Lädt die Verschlagwortungsinformationen(Sord) vom IndexServer. Das gelesene Sord Objekt wird nicht in dem ArchiveElement gespeichert und muss mittels setSord zurückgeschrieben werden wenn man es verändert.

Specified by:

loadSord in class IndexedElement

Returns:

Sord

Throws:

Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei (Postbox) gelesen werden können.

getEditInfo

public EditInfo getEditInfo()

Description copied from class: IndexedElement

Liefert das zugehörige EditInfo-Objekt zurück.

Specified by:

getEditInfo in class IndexedElement

Returns:

EditInfo

setSord

public void setSord(Sord sord)
             throws Exception

Setzt die Verschlagwortungsinformationen(Sord). Die Informationen werden auf dem IndexServer gespeichert.

Specified by:

setSord in class IndexedElement

Parameters:

sord - Verschlagwortungsinformation

Throws:

Exception - Wenn die Daten nicht auf dem Server oder in die ESW Datei (Postbox) gespeichert werden können.

setLock

public boolean setLock()

Setzt eine Sperre auf den Archiveintrag.

Returns:

True wenn die Sperre gesetzt werden konnte, False sonst.

Since:

7.00.004

isLocked

public boolean isLocked()
                 throws Exception

Gibt an, ob der Archiveintrag gesperrt ist.

Returns:

True bei einer gesetzten Sperre, False wenn keine Sperre vorhanden ist.

Throws:

Exception - Wenn die Daten nicht vom Server gelesen werden können.

Since:

8.04.000

removeLock

public void removeLock()
                throws Exception

Entfernt die Sperre vom Archiveintrag.

Throws:

Exception - Wenn der Zugriff auf den Server fehlschlägt.

Since:

7.00.004

isDocument

public abstract boolean isDocument()

Liefert true, wenn dieses Element ein Dokument ist.

Specified by:

isDocument in class IndexedElement

Returns:

boolean

isStructure

public abstract boolean isStructure()

Liefert true, wenn dieses Element ein Ordner ist.

Specified by:

isStructure in class IndexedElement

Returns:

boolean

moveToFolder

public boolean moveToFolder(StructureElement targetFolder,
                            boolean showErrorDialog)

Verschiebt diesen Archiveintrag in den angegebenen Zielordner.

Parameters:

targetFolder - ObjektID des Zielordners

showErrorDialog - True wenn bei Problemen ein Fehlerdialog angezeigt werden soll

Returns:

True bei erfolgreichem Verschieben, False bei einem Fehler

Since:

7.00.004

moveToFolder

public boolean moveToFolder(StructureElement targetFolder,
                            boolean showErrorDialog,
                            int currentParentId)

Verschiebt diesen Archiveintrag in den angegebenen Zielordner unter berücksichtigung von Referenzeinträgen.

Parameters:

targetFolder - ObjektID des Zielordners

showErrorDialog - True wenn bei Problemen ein Fehlerdialog angezeigt werden soll

currentParentId - ObjektID des aktuellen Parent-Ordners. Hier kann auch der Parent einer Referenz dieses Eintrags angegeben werden, um die Referenz zu verschieben.

Returns:

True bei erfolgreichem Verschieben, False bei einem Fehler

Since:

9.00.000

del

public boolean del()
            throws Exception

Description copied from class: IndexedElement

Löscht das Element (und alle Referenzen darauf).

Specified by:

del in class IndexedElement

Returns:

True wenn erfolgreiche gelöscht wurde, False bei Fehlern

Throws:

Exception - Wenn das Objekt nichtr gelöscht werden kann.

referenceIn

public boolean referenceIn(StructureElement newParent)

Referenziert das aktuelle Archivelement in den angegebenen Ordner. Bei ungültigen Parameterangaben wird false zurückgeliefert.

Parameters:

newParent - Ordner, in dem die Referenz erstellt wird

Returns:

True, falls die Referenz erstellt wurde, False bei einem Fehler

Since:

8.00.000

refresh

public void refresh()

Aktualisert den Archiveintrag. Dieser wird dazu neu vom Server geladen und die Darstellung in allen Bereichen des Client aktualisiert.

Since:

8.00.006

getParent

public StructureElement getParent()
                           throws Exception

Liefert den übergeordneten Ordner dieses Eintrags.

Returns:

Übergeordneter Ordner

Throws:

Exception - Wenn die Daten nicht vom Server gelesen werden können.

Since:

8.01.000

addFeedComment

public String addFeedComment(String comment)
                      throws Exception

Erzeugt einen Feed-Kommentar Eintrag.

Parameters:

comment - Feed-Kommentar

Returns:

Erzeugte Feed-Action GUID

Throws:

Exception - Wenn der Eintrag nicht angelegt werden konnte.

Since:

9.00.025