de.elo.client.scripting.items
Class IndexedElement

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

Direct Known Subclasses:

ArchiveElement, IntrayDocument, TaskElement

public abstract class IndexedElement
extends java.lang.Object

Überschrift: IndexedElement

Beschreibung: Ein Element mit Verschlagwortungsinformationen. Dies kann ein Dokument in der Postbox (InTrayDocument), ein Dokument im Archiv (ArchiveDocument) oder ein Strukturelement im Archiv (StructureElement) sein.

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

Constructor Summary

IndexedElement(de.elo.client.maindialog.Workspace workspace)
Normaler Konstruktor.

Method Summary

abstract boolean	del() Löscht das Element (und alle Referenzen darauf).
int	getDocMaskId() Liefert die Masken-ID der derzeit im Dialog angezeigten Verschlagwortungsmaske.
java.lang.String	getDocMaskName() Liefert den Namen der derzeit im Dialog angezeigten Verschlagwortungsmaske.
abstract de.elo.ix.client.EditInfo	getEditInfo() Liefert das zugehörige EditInfo-Objekt zurück.
java.lang.String	getHiddenText() Liefert den versteckten Text des Archivelements zurück.
java.lang.String	getName() Liefert die Kurzbezeichnung dieses Elements.
java.lang.String	getObjKeyValue(int no) Liefert den Wert einer Indexzeile.
java.lang.String	getObjKeyValue(java.lang.String name) Liefert den Wert eines Indexfelds.
java.util.Properties	getProperties() Erzeugt aus dem Zusatztext ein Properties Objekt zum direkten Zugriff auf einzelne Werte.
de.elo.ix.client.Sord	getSord() Liefert die Verschlagwortungsinformation (SORD-Objekt) dieses Elements.
abstract de.elo.ix.client.Sord	loadSord() Lädt die aktuelle Verschlagwortung (vom Server oder (in der Postbox) aus der zugehörigen ESW-Datei).
void	saveSord() Speichert die aktuelle Verschlagwortung auf dem Server oder (in der Postbox) in der zugehörigen ESW-Datei.
void	setHiddenText(java.lang.String text) Setzt den versteckten Text des Archivelements.
void	setMaskId(int maskId) Setzt die Maske für dieses Elements.
void	setName(java.lang.String name) Setzt die Kurzbezeichnung dieses Elements.
void	setObjKeyValue(int no, java.lang.String value) Setzt den Wert eines Indexfelds.
void	setObjKeyValue(java.lang.String name, java.lang.String value) Setzt den Wert eines Indexfelds.
void	setProperties(java.util.Properties properties) Schreibt ein Properties Objekt in den Zusatztext.
abstract void	setSord(de.elo.ix.client.Sord sord) Setzt das angegebene SORD-Objekt als neue Verschlagwortung.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexedElement

public IndexedElement(de.elo.client.maindialog.Workspace workspace)

Normaler Konstruktor.

Parameters:

workspace - Aktueller Arbeitsbereich

Method Detail

getSord

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

Liefert die Verschlagwortungsinformation (SORD-Objekt) dieses Elements.

Returns:

Sord

Throws:

java.lang.Exception

getEditInfo

public abstract de.elo.ix.client.EditInfo getEditInfo()

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

Returns:

EditInfo

Since:

8.00.000

loadSord

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

Lädt die aktuelle Verschlagwortung (vom Server oder (in der Postbox) aus der zugehörigen ESW-Datei).

Returns:

Sord

Throws:

java.lang.Exception

setSord

public abstract void setSord(de.elo.ix.client.Sord sord)
                      throws java.lang.Exception

Setzt das angegebene SORD-Objekt als neue Verschlagwortung.

Parameters:

sord - Verschlagwortungsinformation

Throws:

java.lang.Exception

saveSord

public void saveSord()
              throws java.lang.Exception

Speichert die aktuelle Verschlagwortung auf dem Server oder (in der Postbox) in der zugehörigen ESW-Datei.

Throws:

java.lang.Exception

getName

public java.lang.String getName()
                         throws java.lang.Exception

Liefert die Kurzbezeichnung dieses Elements.

Returns:

Kurzbezeichnung

Throws:

java.lang.Exception

getDocMaskId

public int getDocMaskId()
                 throws java.lang.Exception

Liefert die Masken-ID der derzeit im Dialog angezeigten Verschlagwortungsmaske.

Returns:

int Masken-Id der angezeigten Verschlagwortungsmaske

Throws:

java.lang.Exception

Since:

8.01.000

getDocMaskName

public java.lang.String getDocMaskName()
                                throws java.lang.Exception

Liefert den Namen der derzeit im Dialog angezeigten Verschlagwortungsmaske.

Returns:

String

Throws:

java.lang.Exception

Since:

8.01.000

setName

public void setName(java.lang.String name)
             throws java.lang.Exception

Setzt die Kurzbezeichnung dieses Elements. Ein saveSord ist nötig um diese Änderung zu speichern.

Parameters:

name - Kurzbezeichnung des Archivelementes

Throws:

java.lang.Exception

getHiddenText

public java.lang.String getHiddenText()
                               throws java.lang.Exception

Liefert den versteckten Text des Archivelements zurück.

Returns:

String

Throws:

java.lang.Exception

Since:

7.00.008

setHiddenText

public void setHiddenText(java.lang.String text)
                   throws java.lang.Exception

Setzt den versteckten Text des Archivelements. Ein Aufruf der Methode "saveSord" ist nötig um diese Änderung zu speichern.

Parameters:

text - Versteckter Text des Archivelementes

Throws:

java.lang.Exception

Since:

7.00.008

setMaskId

public void setMaskId(int maskId)
               throws java.lang.Exception

Setzt die Maske für dieses Elements. Ein Aufruf der Methode "saveSord" ist nötig um diese Änderung zu speichern.

Parameters:

maskId - Die MaskenId als Integer

Throws:

java.lang.Exception

getObjKeyValue

public java.lang.String getObjKeyValue(int no)
                                throws java.lang.Exception

Liefert den Wert einer Indexzeile.

Parameters:

no - Nummer der Indexfelds, ACHTUNG: Zählung beginnt hier bei 0

Returns:

Wert der Indexfelds. Falls ein Spaltenindex vorhanden ist, sind die Werte durch ein Pilcrow (¶) getrennt.

Throws:

java.lang.Exception

getObjKeyValue

public java.lang.String getObjKeyValue(java.lang.String name)
                                throws java.lang.Exception

Liefert den Wert eines Indexfelds.

Parameters:

name - Gruppenname des Indexfelds, ACHTUNG: Diese Auswahl ist nicht eindeutig, bei mehreren Indexfelder mit diesem Namen wird das erste geliefert.

Returns:

Wert des Indexfelds. Falls ein Spaltenindex vorhanden ist, sind die Werte durch ein Pilcrow (¶) getrennt.

Throws:

java.lang.Exception

setObjKeyValue

public void setObjKeyValue(int no,
                           java.lang.String value)
                    throws java.lang.Exception

Setzt den Wert eines Indexfelds. Ein Aufruf der Methode "saveSord" ist nötig um diese Änderung zu speichern.

Parameters:

no - Nummer des Indexfelds, ACHTUNG: Zählung beginnt hier bei 0

value - Der zu setzende Wert des Indexfelds. Um einen Spaltenindex zu verwenden, müssen die Werte durch ein Pilcrow (¶) getrennt sein.

Throws:

java.lang.Exception

setObjKeyValue

public void setObjKeyValue(java.lang.String name,
                           java.lang.String value)
                    throws java.lang.Exception

Setzt den Wert eines Indexfelds. Ein saveSord ist nötig um diese Änderung zu speichern.

Parameters:

name - Gruppenname des Indexfelds, ACHTUNG: Diese Auswahl ist nicht eindeutig, bei mehreren Indexfeldern mit diesem Namen wird das erste benutzt.

value - Der zu setzende Wert des Indexfelds. Um einen Spaltenindex zu verwenden, müssen die Werte durch ein Pilcrow (¶) getrennt sein.

Throws:

java.lang.Exception

del

public abstract boolean del()
                     throws java.lang.Exception

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

Returns:

True wenn erfolgreiche gelöscht wurde, False bei Fehlern

Throws:

java.lang.Exception

Since:

7.00.004

getProperties

public java.util.Properties getProperties()
                                   throws java.lang.Exception

Erzeugt aus dem Zusatztext ein Properties Objekt zum direkten Zugriff auf einzelne Werte.

Returns:

Gelesende Daten

Throws:

java.lang.Exception

Since:

8.01.000

setProperties

public void setProperties(java.util.Properties properties)
                   throws java.lang.Exception

Schreibt ein Properties Objekt in den Zusatztext. Ein Aufruf der Methode "saveSord" ist nötig um diese Änderung zu speichern.

Parameters:

properties - Zu setzende Daten

Throws:

java.lang.Exception

Since:

8.01.000