Package de.elo.client.scripting.interfaces

Class ArchiveViews

  • public class ArchiveViews
extends Object

    Überschrift: ArchiveViews

    Beschreibung: Sammlung der im Workspace vorhandenen Archivansichten als Schnittstelle für das Scripting. Im Scripting verfügbar als "archiveViews".

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

    • Constructor Summary

      Constructors 
      Constructor Description
      ArchiveViews​(Workspace workspace)
      Interner Konstruktor.

    • Method Summary

      Modifier and Type Method Description
      ArchiveViewAdapter addArchiveView​(String name, int objId)
      Fügt eine neue Archivansicht in die Oberfläche des Java Clients ein und liefert diese Archivansicht zurück.
      ArchiveViewAdapter getArchiveViewForId​(int objId)
      Liefert eine Archivansicht (die erste in der Reihe des Workspaces), welche die angegebene Objekt-ID enthält.
      ArchiveViewAdapter getArchiveViewForRootId​(int objId)
      Liefert eine Archivansicht (die erste in der Reihe des Workspaces), welche die angegebene Objekt-ID als Startelement enthält.
      ArrayList<ArchiveViewAdapter> getArchiveViews()
      Liefert eine Liste mit den Archivansichten zurück.
      void removeArchiveView​(ArchiveViewAdapter view)
      Entfernt die angegebene Archivansicht aus der Liste mit den vorhandenen Ansichten.

      • Methods inherited from class Object

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

    • Constructor Detail

      • ArchiveViews

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

    • Method Detail

      • getArchiveViews

        public ArrayList<ArchiveViewAdapter> getArchiveViews()
        Liefert eine Liste mit den Archivansichten zurück.
        Returns:
        Liste mit Archivansichten

      • getArchiveViewForId

        public ArchiveViewAdapter getArchiveViewForId​(int objId)
                                       throws Exception
        Liefert eine Archivansicht (die erste in der Reihe des Workspaces), welche die angegebene Objekt-ID enthält.
        Parameters:
        objId - Objekt Id des Archivelementes
        Returns:
        Adapter für die Archivansicht
        Throws:
        Exception - Wenn keine Archivansicht mit diesem Objekt gefunden wird.

      • getArchiveViewForRootId

        public ArchiveViewAdapter getArchiveViewForRootId​(int objId)
                                           throws Exception
        Liefert eine Archivansicht (die erste in der Reihe des Workspaces), welche die angegebene Objekt-ID als Startelement enthält.
        Parameters:
        objId - Objekt Id des Archivelementes
        Returns:
        Adapter für die Archivansicht
        Throws:
        Exception - Wenn keine Archivansicht mit diesem Objekt gefunden wird.
        Since:
        10.00.000

      • addArchiveView

        public ArchiveViewAdapter addArchiveView​(String name,
                                         int objId)
        Fügt eine neue Archivansicht in die Oberfläche des Java Clients ein und liefert diese Archivansicht zurück.
        Parameters:
        name - Bezeichnung der Archivansicht
        objId - Wurzeleintrag dieser Ansicht.
        Returns:
        ArchiveViewAdapter oder null, wenn der Archiveintrag nicht gelesen werden kann
        Since:
        8.00.008

      • removeArchiveView

        public void removeArchiveView​(ArchiveViewAdapter view)
                       throws Exception
        Entfernt die angegebene Archivansicht aus der Liste mit den vorhandenen Ansichten.
        Parameters:
        view - zu löschende Ansicht
        Throws:
        Exception - Wenn die Ansicht nicht gefunden wurde.
        Since:
        10.00.000