Package de.elo.client.scripting.interfaces

Class IntrayAdapter

Object
ViewAdapter
IntrayAdapter
public class IntrayAdapter
extends ViewAdapter

Überschrift: IntrayAdapter

Beschreibung: Kapselt den Funktionsbereich "Postbox" gegenüber dem Script. Im Scripting verfügbar als "intray".

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

  • Constructor Details

    • IntrayAdapter

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

  • Method Details

    • selectRow

      public void selectRow​(int rowNo)
      Selektiert die angebene Zeile in der Postbox-Tabelle.
      Parameters:
      rowNo - Zu selektierende Tabellenzeile, angefangen bei 0

    • selectRows

      public void selectRows​(int[] rowNos)
      Selektiert die angebenen Zeilen in der Postbox. Eine leere Zeilenliste löscht alle Selektionen.
      Parameters:
      rowNos - Liste mit zu selektierenden Tabellenzeilen, angefangen bei 0
      Since:
      7.00.004

    • selectAll

      public void selectAll()
      Selektiert alle vorhandenen Postboxdokumente.
      Since:
      9.01.000

    • clearSelection

      public void clearSelection()
      Entfernt alle Selektionen.
      Since:
      9.03.000

    • selectDocument

      public void selectDocument​(IntrayDocument document) throws Exception
      Selektiert das angegebene Dokument in der Postbox.
      Parameters:
      document - Postbox-Dokument
      Throws:
      Exception - Wenn das Dokument nicht gefunden wird.

    • selectDocuments

      public void selectDocuments​(IntrayDocument[] documents) throws Exception
      Selektiert die angegebenen Dokumente in der Postbox.
      Parameters:
      documents - Liste mit Postbox-Dokumenten
      Throws:
      Exception - Falls eines der Dokumente nicht gefunden wird, bleibt die Selektion unverändert und es wird eine Exception geworfen
      Since:
      6.00.092

    • getDocumentCount

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

    • getDocuments

      public Enumeration<IntrayDocument> getDocuments()
      Liefert eine Aufzählung mit den vorhandenen Postbox-Dokumenten zurück.
      Returns:
      Aufzählung von Postbox-Dokumenten

    • hasSelection

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

    • getSelectionCount

      public int getSelectionCount()
      Liefert die Anzahl der selektieren Postbox-Dokumente zurück.
      Specified by:
      getSelectionCount in class ViewAdapter
      Returns:
      int
      Since:
      7.00.004

    • getSelected

      public Enumeration<IntrayDocument> getSelected()
      Deprecated.
      Ersetzt durch getAllSelected()
      Liefert eine Aufzählung mit den in der Postbox selektierten Elementen.
      Returns:
      Aufzählung von Postbox-Dokumenten

    • getAllSelected

      public Enumeration<IntrayDocument> getAllSelected()
      Liefert eine Aufzählung mit den selektierten Postbox-Dokumenten.
      Specified by:
      getAllSelected in class ViewAdapter
      Returns:
      Aufzählung von Postbox-Dokumenten
      Since:
      7.00.004

    • getFirstSelected

      public IntrayDocument getFirstSelected()
      Liefert das erste selektierte Postbox-Dokument.
      Specified by:
      getFirstSelected in class ViewAdapter
      Returns:
      Das erste Dokument oder null, falls kein Dokument selektiert ist
      Since:
      7.00.004

    • getOcrDocument

      public IntrayDocument getOcrDocument()
      Liefert das gerade von der OCR bearbeitete Postbox-Dokument.
      Returns:
      Das aktuell von der OCR bearbeitete Dokument oder null, fall kein Dokument von der OCR bearbeitet wird
      Since:
      7.00.008

    • hasOcr

      public boolean hasOcr()
      Prüft, ob die Hintergrund-OCR der Postbox einsatzbereit ist.
      Returns:
      True wenn die OCR verfügbar ist, False wenn nicht
      Since:
      8.04.000

    • 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

    • getDirectory

      public File getDirectory()
      Liefert das Postbox-Verzeichnis aus dem lokalen Dateisystem.
      Returns:
      File
      Since:
      6.00.100

    • refresh

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

    • updateDefaultIndexing

      public final void updateDefaultIndexing()
      Aktualisiert die Default-Maske
      Since:
      10.03.000

    • getScanProfileName

      public final String getScanProfileName()
      Liefert den Namen des aktuell aktiven Scan-Profiles.
      Returns:
      Name des Scan-Profiles. Falls kein Scan-Profile definiert oder selektiert wurde, wird ein Leerstring zurückgegeben.
      Since:
      7.00.000

    • insertFile

      public IntrayDocument insertFile​(File file) throws IOException
      Fügt eine Dokument-Datei in die Postbox ein. Die Originaldatei wird dabei kopiert.
      Parameters:
      file - Originaldatei
      Returns:
      Kopiertes Postbox-Dokument
      Throws:
      IOException - Falls die Datei nicht hinzu gefügt werden kann.
      Since:
      7.00.004