Package de.elo.client.scripting.interfaces

Class ArchiveViewAdapter

  • public class ArchiveViewAdapter
extends ViewAdapter

    Überschrift: ArchiveViewAdapter

    Beschreibung: Kapselt einen Archiv-Funktionsbereich (Archivansicht) gegenüber dem Script.

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

    • Constructor Detail

      • ArchiveViewAdapter

        public ArchiveViewAdapter​(Workspace workspace,
                          ArchiveView archiveView)
        Interner Konstruktor.
        Parameters:
        workspace - Aktueller Arbeitsbereich
        archiveView - Ansicht für den Archiv-Funktionsbereich

    • Method Detail

      • hasSelection

        public boolean hasSelection()
        Prüft ob mindestens ein Archiveintrag selektiert wurde.
        Specified by:
        hasSelection in class ViewAdapter
        Returns:
        True wenn eine Selektion vorhanden ist, False wenn keine Selektion vorhanden ist.

      • getSelectionCount

        public int getSelectionCount()
        Liefert die Anzahl an selektieren Archiveinträgen in dieser Archivansicht. Eine Selektion in der Vorschautabelle wird ebenfalls berücksichtigt.
        Specified by:
        getSelectionCount in class ViewAdapter
        Returns:
        Anzahl selektierte Archiveinträge
        Since:
        7.00.004

      • getSelected

        public ArchiveElement getSelected()
        Deprecated.
        Ersetzt durch getFirstSelected()
        Liefert den ersten in dieser Archivansicht selektierten Archiveintrag. Eine Selektion in der Vorschautabelle wird ebenfalls berücksichtigt.
        Returns:
        Archiveintrag oder null, falls keine Selektion vorhanden ist

      • getFirstSelected

        public ArchiveElement getFirstSelected()
        Liefert den ersten in dieser Archivansicht selektierten Archiveintrag. Eine Selektion in der Vorschautabelle wird ebenfalls berücksichtigt.
        Specified by:
        getFirstSelected in class ViewAdapter
        Returns:
        Archiveintrag oder null, falls keine Selektion vorhanden ist
        Since:
        7.00.004

      • getAllSelected

        public Enumeration<ArchiveElement> getAllSelected()
        Liefert alle selektierten Archiveinträge. Eine Selektion in der Vorschautabelle wird ebenfalls berücksichtigt.
        Specified by:
        getAllSelected in class ViewAdapter
        Returns:
        Aufzählung mit selektierten Archiveinträgen
        Since:
        7.00.004

      • selectId

        public boolean selectId​(int objId)
        Selektiert den angebene Archiveintrag.
        Parameters:
        objId - ObjektID des Archiveintrags
        Returns:
        True, wenn erfolgreich selektiert wurde

      • getId

        public ArchiveElement getId​(int objId)
                     throws Exception
        Liefert das durch Id identifizierte Archivelement zurück.
        Parameters:
        objId - Objekt-ID des Archivelementes
        Returns:
        ArchiveElement Das ArchivElement
        Throws:
        Exception - Wenn das Objekt nicht in der Ansicht gefunden wird.

      • hasId

        public boolean hasId​(int objId)
        Meldet zurück, ob das Archiv das übergebene Archivelement enthält.
        Parameters:
        objId - Objekt-ID des Archivelements
        Returns:
        True, wenn Archivelement vorhanden ist

      • getRootElement

        public ArchiveElement getRootElement()
        Liefert das Root-Archivelement(das oberste Archivelement dieser Archivansicht) zurück.
        Returns:
        ArchiveElement

      • getName

        public String getName()
        Description copied from class: ViewAdapter
        Gibt den Namen der Ansicht zurück. Bei Archivansichten ist das der Name des Root-Elements, bei anderen Ansichten der Name der Ansicht "Archive: (Rootname)", "Checkout", "Clipboard", "Search", "Task", "Intray".
        Specified by:
        getName in class ViewAdapter
        Returns:
        String

      • getViewName

        public String getViewName()
        Liefert die vom Benutzer eingegebene Bezeichnung der Archivansicht zurück.
        Overrides:
        getViewName in class ViewAdapter
        Returns:
        Vom Benutzer eingegebene Bezeichnung der Archivansicht
        Since:
        9.01.014, 8.05.005

      • refresh

        public void refresh()
        Description copied from class: ViewAdapter
        Aktualisiert den Inhalt dieser Ansicht.
        Specified by:
        refresh in class ViewAdapter

      • refreshArchive

        public void refreshArchive()
        Löst ein Refresh auf den kompletten Archivbaum aus.
        Overrides:
        refreshArchive in class ViewAdapter
        Since:
        8.01.000

      • getFirstSelectedPath

        public IdName[] getFirstSelectedPath()
        Liefert den Pfad des ersten selektierten Eintrags in dieser Archivansicht zurück.
        Returns:
        Pfad des selektierten Eintrags
        Since:
        9.01.000

      • gotoPath

        public boolean gotoPath​(IdName[] path)
        Zeigt den Archiveintrag für den angegebenen Pfad an und meldet das Ergebnis zurück.
        Parameters:
        path - Pfad des Archiveintrags
        Returns:
        GeheZu-Vorgang erfolgreich
        Since:
        9.01.000