Package de.elo.client.scripting.interfaces

Class CheckoutAdapter

Object
ViewAdapter
CheckoutAdapter
public class CheckoutAdapter
extends ViewAdapter

Überschrift: CheckoutAdapter

Beschreibung: Kapselt den Funktionsbereich "In Bearbeitung" gegenüber dem Script. Im Scripting verfügbar als "checkout".

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

  • Constructor Details

    • CheckoutAdapter

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

  • Method Details

    • selectRow

      public void selectRow​(int rowNo)
      Selektiert die angegebene Zeile in der Tabelle mit den ausgecheckten Dokumenten.
      Parameters:
      rowNo - Zeilennummer

    • selectRows

      public void selectRows​(int[] rowNos)
      Selektiert die angebenen Zeilen in der Tabelle mit den ausgecheckten Dokumenten.
      Parameters:
      rowNos - Liste mit den zu selektierenden Tabellenzeilen, angefangen bei 0
      Since:
      7.00.004

    • hasSelection

      public boolean hasSelection()
      Prüft, ob im Funktionsbereich "In Bearbeitung" (Checkout) mindestens ein Element selektiert wurde.
      Specified by:
      hasSelection in class ViewAdapter
      Returns:
      boolean

    • getSelectionCount

      public int getSelectionCount()
      Liefert die Anzahl an selektieren Dokumente im Funktionsbereich "In Bearbeitung".
      Specified by:
      getSelectionCount in class ViewAdapter
      Returns:
      Anzahl der selektierten Dokumente
      Since:
      7.00.004

    • selectId

      public void selectId​(int objId) throws Exception
      Selektiert die angegebene ObjektId (falls vorhanden) in der Tabelle mit den ausgecheckten Dokumenten.
      Parameters:
      objId - Objekt Id des Archivelementes
      Throws:
      Exception - falls die Objekt Id nicht vorhanden

    • selectDocument

      public void selectDocument​(CheckoutDocument document) throws Exception
      Selektiert das angegebene CheckoutDokument in der Tabelle mit den ausgecheckten Dokumenten.
      Parameters:
      document - Ausgechecktes Dokument
      Throws:
      Exception - Falls die Objekt Id nicht vorhanden ist.

    • getDocumentCount

      public int getDocumentCount()
      Liefert die Anzahl der ausgecheckten Dokumente zurück.
      Returns:
      Anzahl der ausgecheckten Dokumente

    • getDocuments

      public Enumeration<CheckoutDocument> getDocuments()
      Liefert eine Aufzählung mit allen ausgecheckten Dokumenten zurück.
      Returns:
      Aufzählung ausgecheckter Dokumente

    • getSelected

      public Enumeration<CheckoutDocument> getSelected()
      Deprecated.
      Ersetzt durch getAllSelected()
      Liefert eine Aufzählung mit allen im Funktionsbereich "In Bearbeitung" selektierten Dokumenten.
      Returns:
      Aufzählung ausgecheckter Dokumente

    • getFirstSelected

      public CheckoutDocument getFirstSelected()
      Liefert das erste im Funktionsbereich "In Bearbeitung" selektierte Dokument.
      Specified by:
      getFirstSelected in class ViewAdapter
      Returns:
      CheckoutDocument oder null, falls kein Dokument selektiert ist
      Since:
      7.00.004

    • getAllSelected

      public Enumeration<CheckoutDocument> getAllSelected()
      Liefert eine Aufzählung mit allen im Funktionsbereich "In Bearbeitung" selektierten Dokumenten.
      Specified by:
      getAllSelected in class ViewAdapter
      Returns:
      Aufzählung von Checkout-Dokumenten.
      Since:
      7.00.004

    • 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

    • refresh

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

    • getLastFile

      public File getLastFile()
      Deprecated.
      Ersetzt durch getLastDocument()
      Liefert die zuletzte ausgecheckte Dokumentdatei. Diese Funktion sollte mit dem Event CheckoutDocumentAvailable benutzt werden.
      Returns:
      File Dokumentdatei
      Since:
      7.00.014

    • getLastDocument

      public CheckoutDocument getLastDocument()
      Liefert das zuletzte ausgecheckte Dokument. Diese Funktion sollte zusammen mit dem Event CheckoutDocumentAvailable benutzt werden.
      Returns:
      Dokument in Bearbeitung
      Since:
      8.04.000

    • addDocument

      public File addDocument​(Sord checkoutSord, File source) throws IOException, NavigationViewNotFoundException, CheckOutException
      Fügt eine Datei in den Checkout Bereich ein. Diese Funktion unterstützt die Anlage von neuen Dokumenten, die im Checkout Zustand erzeugt werden sollen, ohne dass eine nutzlose erste Dummy Version im Archiv hinterlegt werden muss.
      Parameters:
      checkoutSord - Verschlagwortung des neuen Dokuments
      source - Zu kopierende Quelldatei
      Returns:
      Datei im Checkout Verzeichnis
      Throws:
      IOException - Wenn die Dokumentdatei nicht in den Checkout kopiert werden kann.
      NavigationViewNotFoundException - Falls der Checkout Bereich nicht gefunden wird.
      CheckOutException - Wenn das Objekt nicht ausgecheckt werden kann.
      Since:
      8.01.000