Package de.elo.client.scripting.items

Class IndexedElement

  • Direct Known Subclasses:
    ArchiveElement, IntrayDocument, TaskElement
    public abstract class IndexedElement
extends 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-2014

    • Constructor Summary

      Constructors 
      Constructor Description
      IndexedElement​(Workspace workspace)
      Interner Konstruktor.
      IndexedElement​(Workspace workspace, Sord sord)
      Interner Konstruktor.

    • Method Summary

      Modifier and Type Method Description
      abstract boolean del()
      Löscht das Element (und alle Referenzen darauf).
      DocMask getDocMask()
      Liefert die derzeit im Dialog angezeigte Verschlagwortungsmaske zurück.
      int getDocMaskId()
      Liefert die Masken-ID der derzeit im Dialog angezeigten Verschlagwortungsmaske.
      String getDocMaskName()
      Liefert den Namen der derzeit im Dialog angezeigten Verschlagwortungsmaske.
      abstract EditInfo getEditInfo()
      Liefert das zugehörige EditInfo-Objekt zurück.
      String getHiddenText()
      Liefert den versteckten Text des Archivelements zurück.
      String getMainScale()
      Liest die Skalierungsfaktoren des Dokuments für die Anpassung der Annotationen.
      String getName()
      Liefert die Kurzbezeichnung dieses Elements.
      String getObjKeyValue​(int no)
      Liefert den Wert einer Indexzeile.
      String getObjKeyValue​(String name)
      Liefert den Wert eines Indexfelds.
      Properties getProperties()
      Erzeugt aus dem Zusatztext ein Properties Objekt zum direkten Zugriff auf einzelne Werte.
      String getReadableFileSize()
      Liefert die Größe der Datei als formatierten String zurück.
      Sord getSord()
      Liefert die Verschlagwortungsinformation (SORD-Objekt) dieses Elements.
      abstract boolean isDocument()
      Liefert true, wenn dieses Element ein Dokument ist.
      abstract boolean isStructure()
      Liefert true, wenn dieses Element ein Ordner ist.
      abstract 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​(String text)
      Setzt den versteckten Text des Archivelements.
      void setMainScale​(String mainScale)
      Setzt die Skalierungsfaktoren des Dokuments für die Anpassung der Annotationen.
      void setMaskId​(int maskId)
      Setzt die Maske für dieses Elements.
      void setMaskIdWithDefaults​(int maskId, boolean resetDefaults)
      Setzt eine neue Maske für die Verschlagwortung unter Beibehaltung der eingetragenen Indexzeilen.
      void setName​(String name)
      Setzt die Kurzbezeichnung dieses Elements.
      void setObjKeyValue​(int no, String value)
      Setzt den Wert eines Indexfelds.
      void setObjKeyValue​(String name, String value)
      Setzt den Wert eines Indexfelds.
      void setProperties​(Properties properties)
      Schreibt ein Properties Objekt in den Zusatztext.
      abstract void setSord​(Sord sord)
      Setzt das angegebene SORD-Objekt als neue Verschlagwortung.

      • Methods inherited from class Object

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

    • Constructor Detail

      • IndexedElement

        public IndexedElement​(Workspace workspace)
        Interner Konstruktor.
        Parameters:
        workspace - Aktueller Arbeitsbereich

      • IndexedElement

        public IndexedElement​(Workspace workspace,
                      Sord sord)
        Interner Konstruktor.
        Parameters:
        workspace - Aktueller Arbeitsbereich
        sord - Sord mit mbAll

    • Method Detail

      • getSord

        public Sord getSord()
             throws Exception
        Liefert die Verschlagwortungsinformation (SORD-Objekt) dieses Elements.
        Returns:
        Sord
        Throws:
        Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei gelesen werden können.

      • getEditInfo

        public abstract EditInfo getEditInfo()
        Liefert das zugehörige EditInfo-Objekt zurück.
        Returns:
        EditInfo
        Since:
        8.00.000

      • loadSord

        public abstract Sord loadSord()
                       throws Exception
        Lädt die aktuelle Verschlagwortung (vom Server oder (in der Postbox) aus der zugehörigen ESW-Datei).
        Returns:
        Sord
        Throws:
        Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei (Postbox) gelesen werden können.

      • setSord

        public abstract void setSord​(Sord sord)
                      throws Exception
        Setzt das angegebene SORD-Objekt als neue Verschlagwortung.
        Parameters:
        sord - Verschlagwortungsinformation
        Throws:
        Exception - Wenn die Daten nicht auf dem Server oder in die ESW Datei (Postbox) gespeichert werden können.

      • saveSord

        public void saveSord()
              throws Exception
        Speichert die aktuelle Verschlagwortung auf dem Server oder (in der Postbox) in der zugehörigen ESW-Datei.
        Throws:
        Exception - Wenn die Daten nicht auf dem Server oder in die ESW Datei (Postbox) gespeichert werden können.

      • getName

        public String getName()
               throws Exception
        Liefert die Kurzbezeichnung dieses Elements.
        Returns:
        Kurzbezeichnung
        Throws:
        Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei (Postbox) gelesen werden können.

      • getReadableFileSize

        public String getReadableFileSize()
        Liefert die Größe der Datei als formatierten String zurück.
        Returns:
        Dateigröße als Text mit Angabe der Einheit
        Since:
        11.00.000

      • getDocMaskId

        public int getDocMaskId()
                 throws Exception
        Liefert die Masken-ID der derzeit im Dialog angezeigten Verschlagwortungsmaske.
        Returns:
        int Masken-Id der angezeigten Verschlagwortungsmaske
        Throws:
        Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei (Postbox) gelesen werden können.
        Since:
        8.01.000

      • getDocMaskName

        public String getDocMaskName()
                      throws Exception
        Liefert den Namen der derzeit im Dialog angezeigten Verschlagwortungsmaske.
        Returns:
        String
        Throws:
        Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei (Postbox) gelesen werden können.
        Since:
        8.01.000

      • getDocMask

        public DocMask getDocMask()
                   throws Exception
        Liefert die derzeit im Dialog angezeigte Verschlagwortungsmaske zurück.
        Returns:
        Verschlagwortungsmaske
        Throws:
        Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei (Postbox) gelesen werden können.
        Since:
        9.01.000

      • setName

        public void setName​(String name)
             throws Exception
        Setzt die Kurzbezeichnung dieses Elements. Ein saveSord ist nötig um diese Änderung zu speichern.
        Parameters:
        name - Kurzbezeichnung des Archivelementes
        Throws:
        Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei (Postbox) gelesen werden können.

      • getHiddenText

        public String getHiddenText()
                     throws Exception
        Liefert den versteckten Text des Archivelements zurück.
        Returns:
        String
        Throws:
        Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei (Postbox) gelesen werden können.
        Since:
        7.00.008

      • setHiddenText

        public void setHiddenText​(String text)
                   throws 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:
        Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei (Postbox) gelesen werden können.
        Since:
        7.00.008

      • setMaskId

        public void setMaskId​(int maskId)
               throws 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:
        Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei (Postbox) gelesen werden können.

      • setMaskIdWithDefaults

        public void setMaskIdWithDefaults​(int maskId,
                                  boolean resetDefaults)
                           throws Exception
        Setzt eine neue Maske für die Verschlagwortung unter Beibehaltung der eingetragenen Indexzeilen. Optional werden die default-Werte aus der Maskendefinition überschrieben: Indexzeilen, Archivierungsart, Sortierung, Volltextflag, Berechtigungen, Farbmarker.
        Parameters:
        maskId - Masken-ID
        resetDefaults - TRUE, wenn die Default-Werte der Maske übernommen werden sollen.
        Throws:
        Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei (Postbox) gelesen werden können.
        Since:
        9.00.026

      • getObjKeyValue

        public String getObjKeyValue​(int no)
                      throws 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:
        Exception - Wenn das Indexfeld nicht gefunden werden kann.

      • getObjKeyValue

        public String getObjKeyValue​(String name)
                      throws 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:
        Exception - Wenn das Indexfeld nicht gefunden werden kann.

      • setObjKeyValue

        public void setObjKeyValue​(int no,
                           String value)
                    throws 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:
        Exception - Wenn das Indexfeld nicht gefunden werden kann.

      • setObjKeyValue

        public void setObjKeyValue​(String name,
                           String value)
                    throws 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:
        Exception - Wenn das Indexfeld nicht gefunden werden kann.

      • setMainScale

        public void setMainScale​(String mainScale)
                  throws Exception
        Setzt die Skalierungsfaktoren des Dokuments für die Anpassung der Annotationen.
        Parameters:
        mainScale - Skalierungsfaktoren
        Throws:
        Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei (Postbox) gelesen werden können.
        Since:
        8.04.000

      • getMainScale

        public String getMainScale()
                    throws Exception
        Liest die Skalierungsfaktoren des Dokuments für die Anpassung der Annotationen.
        Returns:
        Skalierungsfaktoren
        Throws:
        Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei (Postbox) gelesen werden können.
        Since:
        8.05.000

      • del

        public abstract boolean del()
                     throws Exception
        Löscht das Element (und alle Referenzen darauf).
        Returns:
        True wenn erfolgreiche gelöscht wurde, False bei Fehlern
        Throws:
        Exception - Wenn das Objekt nichtr gelöscht werden kann.
        Since:
        7.00.004

      • getProperties

        public Properties getProperties()
                         throws Exception
        Erzeugt aus dem Zusatztext ein Properties Objekt zum direkten Zugriff auf einzelne Werte.
        Returns:
        Gelesende Daten
        Throws:
        Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei (Postbox) gelesen werden können.
        Since:
        8.01.000

      • setProperties

        public void setProperties​(Properties properties)
                   throws 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:
        Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei (Postbox) gelesen werden können.
        Since:
        8.01.000

      • isDocument

        public abstract boolean isDocument()
        Liefert true, wenn dieses Element ein Dokument ist.
        Returns:
        boolean
        Since:
        8.04.000

      • isStructure

        public abstract boolean isStructure()
        Liefert true, wenn dieses Element ein Ordner ist.
        Returns:
        boolean
        Since:
        8.04.000