de.elo.client.scripting.items
Class ArchiveElement

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

Direct Known Subclasses:

ArchiveDocument, StructureElement

public abstract class ArchiveElement
extends IndexedElement

Überschrift: ArchiveElement

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

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

Constructor Summary

ArchiveElement(de.elo.client.maindialog.Workspace workspace, int id)
Konstruktor für die Klasse "ArchiveElement".

Method Summary

boolean	del() Löscht das Element (und alle Referenzen darauf).
de.elo.ix.client.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.
abstract boolean	isStructure() Liefert true, wenn dieses Element ein Ordner ist.
de.elo.ix.client.Sord	loadSord() Lädt die Verschlagwortungsinformationen(Sord) vom IndexServer.
de.elo.client.ioutil.ListCache.MoveObjectResult	moveToFolder(StructureElement targetFolder, boolean showErrorDialog) Verschiebt diesen Archiveintrag in den angegebenen Zielordner.
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(de.elo.ix.client.Sord sord) Setzt die Verschlagwortungsinformationen(Sord).

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

ArchiveElement

public ArchiveElement(de.elo.client.maindialog.Workspace workspace,
                      int id)

Konstruktor für die Klasse "ArchiveElement".

Parameters:

workspace - Aktueller Arbeitsbereich

id - ObjektId des Archiveintrags

Method Detail

getId

public int getId()

Liefert die ObjektID des Archiveintrags zurück.

Returns:

int

loadSord

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

Lädt die Verschlagwortungsinformationen(Sord) vom IndexServer.

Specified by:

loadSord in class IndexedElement

Returns:

Sord

Throws:

java.lang.Exception

getEditInfo

public de.elo.ix.client.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(de.elo.ix.client.Sord sord)
             throws java.lang.Exception

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

Specified by:

setSord in class IndexedElement

Parameters:

sord - Verschlagwortungsinformation

Throws:

java.lang.Exception

setLock

public boolean setLock()
                throws java.lang.Exception

Setzt eine Sperre auf den Archiveintrag.

Returns:

True wenn die Sperre gesetzt werden konnte, False sonst.

Throws:

java.lang.Exception

Since:

7.00.004

removeLock

public void removeLock()
                throws java.lang.Exception

Entfernt die Sperre vom Archiveintrag.

Throws:

java.lang.Exception

Since:

7.00.004

isDocument

public abstract boolean isDocument()

Liefert true, wenn dieses Element ein Dokument ist.

Returns:

boolean

isStructure

public abstract boolean isStructure()

Liefert true, wenn dieses Element ein Ordner ist.

Returns:

boolean

moveToFolder

public de.elo.client.ioutil.ListCache.MoveObjectResult 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

del

public boolean del()
            throws java.lang.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:

java.lang.Exception

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 java.lang.Exception

Liefert den übergeordneten Ordner dieses Eintrags.

Returns:

Übergeordneter Ordner

Throws:

java.lang.Exception

Since:

8.01.000