Package de.elo.client.scripting.interfaces

Class WorkspaceAdapter

Object
WorkspaceAdapter
public class WorkspaceAdapter
extends Object

Überschrift: WorkspaceAdapter.

Beschreibung: Kapselt den Workspace gegenüber dem Script. Im Scripting verfügbar als "workspace".

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

  • Constructor Summary

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

  • Method Summary

    Modifier and Type Method Description
    boolean activateRibbonTab​(String tabName)
    Aktiviert den angegebenen Ribbon-Tab und meldet zurück, ob der Vorgang erfolgreich war.
    void addHotKey​(String keyName, String eventName)
    Registriert eine Skriptfunktion zum Aufruf über einen HotKey.
    void addReportEntry​(int objid, int actionNo, int extra1, int extra2, String message)
    Schreibt einen Report Eintrag in die Datenbank.
    ExtraView addView​(String viewName, boolean closeable, JComponent navigationComponent, JComponent topComponent)
    Fügt einen neuen Funktionsbereich in die Navigationsleiste ein.
    AppDialog createAppDialog​(String title)
    Erzeugt einen Dialog in welchem Webanwendungen geladen werden können.
    GridDialog createGridDialog​(String title, int columns, int rows)
    Erzeugt einen Dialog mit einem Tabellenlayout.
    String doImport​(String sourcePath, int targetId, int guidMethod, long flags)
    Führt einen Importvorgang mit den angegebenen Parametern durch.
    ViewAdapter getActiveView()
    Liefert einen Adapter für die aktuelle Ansicht zurück.
    String getClientVersion()
    Liefert die Versionsnummer dieses Clients.
    int getConnectionNumber()
    Liefert zurück, in welcher Ansicht (0 oder 1) das Skript gerade läuft.
    String getCookie​(String key)
    Liefert den Wert eines Cookies aus dem Ole Automation Interface zurück.
    DirectoriesAdapter getDirectories()
    Liefert ein Objekt für den Zugriff auf die lokalen Client Verzeichnisse.
    DocMask getDocMask​(String maskName)
    Liefert das Indexserver Objekt DocMask zu einem Maskennamen zurück.
    String getELOas​(String serverName, int port, String serviceName, boolean withTicket, boolean useSSL, String rulesetName, String... params)
    Synchroner Aufruf eine ELOas Ruleset mit Rückgabewert.
    String getELOas​(String serverName, int port, String serviceName, boolean withTicket, String rulesetName, String param1, String param2, String param3)
    Synchroner Aufruf eine ELOas Ruleset mit Rückgabewert.
    String getFromUrl​(String url)
    Aufruf eines http-Get mit der übergebenen URL.
    HintManager getHintManager()
    Deprecated. 
    IndexPreviewAdapter getIndexPreview()
    Deprecated.
    20.00
    String getLanguage()
    Liefert die eingestellte Sprache des Clients, z.B.
    int getLastInsertedDocument()
    Liefert die Id des zuletzt abgelegten Dokumentes zurück.
    String[] getUserGroupNames()
    Liefert eine Liste aller Gruppen des aktuellen Anwenders zurück
    int[] getUserGroups()
    Liefert eine Liste aller Gruppen des aktuellen Anwenders zurück
    int getUserId()
    Liefert die Id des aktuell angemeldeten Anwenders zurück oder -1 wenn kein Anwender angemeldet ist.
    String getUserName()
    Liefert den Namen des aktuell am Client angemeldeten Benutzers.
    int getUserNodeId()
    Liefert die ELO ObjectId des Anwenderordners zurück.
    int getUserPersonalNodeId()
    Liefert die ELO ObjectId des persönlichen Anwenderordners zurück.
    UserRightsAdapter getUserRights()
    Liefert ein Objekt für den Zugriff auf die Anwenderrechte.
    Workspace getWorkspace()
    Deprecated.
    Diese Funktion macht interne Klassen des Clients sichtbar.
    boolean gotoGuid​(String guid)
    Springt im Archiv an das Element mit der angegebenen Objekt-GUID.
    boolean gotoId​(int objId)
    Springt im Archiv an das Element mit der angegebenen ObjektID.
    boolean gotoWorkflow​(int flowId, int nodeId)
    Wechselt in die Aufgabenansicht und zeigt den angegebenen Workflow an.
    boolean hasModalDialogOpened()
    Meldet zurück, ob ein modaler Dialog offen ist.
    int incCounter​(String counterName, int defaultValue)
    Zählt den angegebenen Counter um einen Wert hoch.
    boolean isFunctionEnabled​(int functionID)
    Deprecated.
    ersetzt durch isFunctionEnabled(String)
    boolean isFunctionEnabled​(String functionName)
    Prüft ob die Funktion mit dem angegebenen Funktionsnamen im derzeitigen Zustand des Clients (aktiver Funktionsbereich, aktuelle Selektion...) verfügbar ist.
    boolean isMemberOf​(String idOrName)
    Meldet zurück, ob der aktuelle Anwender Mitglied einer Gruppe ist.
    void listServerProcess​(String jobTypeName, String jobGuid, String message)
    Zeigt einen gestarteten Serverprozess in der Prozessliste des Java Clients.
    int lookupMaskId​(String maskName)
    Deprecated.
    Ersetzt durch ArchiveAdapter.lookupMaskId(String)
    int publishStoreTile​(int sourceId)
    Zeigt eine Liste aller Store-Bereiche an in denen der Anwender Einträge einfügen darf.
    void removeView​(String viewIdOrName)
    Entfernt einen zusätzlichen Funktionsbereich, welcher vorher über addView angelegt wurde.
    int runELOas​(String serverName, int port, String serviceName, boolean withTicket, boolean useSSL, String rulesetName, String... params)
    Aufruf eine ELOas Ruleset.
    int runELOas​(String serverName, int port, String serviceName, boolean withTicket, String rulesetName, String param1, String param2, String param3)
    Aufruf eine ELOas Ruleset.
    Sord selectStoreTile()
    Zeigt eine Übersicht aller Kacheln im lokalen Store.
    void sendBroadcast​(CONSTANTS.DESTINATION_WORKSPACE destination, String tag, String message)
    Sendet eine Nachricht an dem angegebenen Workspace.
    void sendELOasRequest​(String serverName, int port, String serviceName, boolean withTicket, String rulesetName, String param1, String param2, String param3)
    Deprecated.
    Dieser Aufruf hat einen Fehler, der serviceName muss mit "/" beginnen, damit er funktioniert.
    String sendHttpRequest​(String url)
    Sendet eine HTTP Anfrage und liefert die Response.
    void sendMail​(String subject, String receiver, String content, String[] attachNames)
    Versendet eine Mail
    void setCookie​(String key, String value)
    Setzt ein Cookie im OleAutomation Interface.
    void setFeedbackMessage​(CONSTANTS.FEEDBACK_TYPE type, String messageText)
    Setzt einen Text welcher kurz im Workspace eingeblendet wird.
    void setFeedbackMessage​(String messageText)
    Setzt einen Text welcher kurz im Workspace eingeblendet wird.
    void setNormalCursor()
    Setzt den normalen Mauszeiger.
    void setPageCachePage​(int objectId, int page, boolean onlyIfNew)
    Setzt die Seitennummer zu einem Eintrag im PageCache.
    boolean setRibbonTab​(String tabName)
    Schaltet auf einen ausgewählten Ribbon-Tab um.
    void setScriptButtonEnabled​(int nr, boolean enabled)
    Setzt die Aktivierung eines ScriptButtons.
    void setScriptButtonEnabled​(int nr, boolean document, boolean folder, boolean reminder, boolean workflow, boolean activity, boolean multiselect)
    Definiert eine Regel für die Aktivierung eines ScriptButtons.
    void setScriptButtonEnabled​(int nr, String functionName)
    Koppelt die Aktivierung eines ScriptButtons an eine die Aktivierung einer Client-Funktion.
    void setStatusMessage​(String messageText)
    Setzt den angegebenen Text in der Statuszeile des Java Client.
    void setSyncCallback​(String callbackName)
    Setzt den Namen der Callback Funktion in der MobileSync Behandlung.
    void setWaitCursor()
    Setzt den Warte-Mauszeiger.
    void showAlertBox​(String title, String text)
    Zeigt einen Warndialog mit den angegebenen Titel und Text.
    void showArchiveView()
    Zeigt den Funktionsbereicht "Archiv".
    void showCheckoutView()
    Zeigt den Funktionsbereicht "In Bearbeitung".
    void showClipboardView()
    Zeigt den Funktionsbereicht "Klemmbrett".
    int showCommandLinkDialog​(String dlgTitel, String dlgHeader, String dlgText, CONSTANTS.DIALOG_ICON dlgIcon, String[] optionNames, String[] optionDescriptions, ArchiveDocument[] optionIcons)
    Zeiget einen Dialog mit mehreren CommandLinks an.
    File[] showFileChooserDialog​(String dlgTitle, boolean saveMode, boolean selectOnlyFiles, String selectionPath)
    Zeigt einen Dialog für die Dateiauswahl an und liefert die selektierten Dateien oder Ordner zurück.
    void showInfoBox​(String title, String text)
    Zeigt einen Informationsdialog mit den angegebenen Titel und Text.
    String showInputBox​(String title, String text, String defaultValue, int minLength, int maxLength, boolean isPwdDialog, int alignment)
    Zeigt eine Input Box an.
    void showIntrayView()
    Zeigt den Funktionsbereicht "Postbox".
    void showMyEloView()
    Zeigt den Funktionsbereich "Mein ELO".
    AclItem[] showPermissionsDialog​(String dialogTitle, AclItem[] currentPermissions)
    Zeigt einen Dialog zur Auswahl/Einstellung von Berechtigungen.
    boolean showQuestionBox​(String title, String text)
    Zeigt einen Fragedialog mit den angegebenen Titel und Text.
    void showSearchView()
    Zeigt den Funktionsbereicht "Suche".
    String showSimpleInputBox​(String title, String text, String defaultValue)
    Zeigt eine Input Box an.
    void showTasksView()
    Zeigt den Funktionsbereicht "Aufgaben".
    int showTreeSelectDialog​(String title, String message, int rootId, boolean documentsSelectable, boolean folderSelectable, boolean showFavorites)
    Zeigt einen Dialog zur Auswahl eines Ordners oder Dokuments im Archiv an.
    int showTreeSelectDialog​(String title, String message, int rootId, boolean documentsSelectable, boolean folderSelectable, boolean showFavorites, boolean showAddFolderButton, int selectedId)
    Zeigt einen Dialog für die Auswahl eines Archiveintrags an.
    int showTreeSelectDialog​(String title, String message, int rootId, boolean documentsSelectable, boolean folderSelectable, boolean showFavorites, boolean showAddFolderButton, int selectedId, File sourceFile)
    Zeigt einen Dialog für die Auswahl eines Archiveintrags an.
    UserName[] showUserSelectionDialog​(boolean multiselect, int min, int max, boolean allowUsers, boolean allowGroups)
    Zeigt einen Dialog zur Auswahl von Anwendern und/oder Gruppen.
    UserName[] showUserSelectionDialog​(boolean multiselect, int min, int max, boolean allowUsers, boolean allowGroups, boolean allowOptionGroups, boolean allowGlobal, UserName[] currentUsers, boolean onlyDisplayableUsers, boolean suppressOwnUser)
    Zeigt einen Dialog zur Auswahl von Anwendern und/oder Gruppen.
    UserName[] showUserSelectionDialog​(boolean multiselect, int min, int max, boolean allowUsers, boolean allowGroups, boolean allowOptionGroups, UserName[] currentUsers, boolean onlyDisplayableUsers, boolean suppressOwnUser)
    Zeigt einen Dialog zur Auswahl von Anwendern und/oder Gruppen.
    UserName[] showUserSelectionDialog​(boolean multiselect, int min, int max, boolean allowUsers, boolean allowGroups, UserName[] currentUsers)
    Zeigt einen Dialog zur Auswahl von Anwendern und/oder Gruppen.
    UserName[] showUserSelectionDialog​(boolean multiselect, int min, int max, boolean allowUsers, boolean allowGroups, UserName[] currentUsers, boolean onlyDisplayableUsers)
    Zeigt einen Dialog zur Auswahl von Anwendern und/oder Gruppen.
    UserName[] showUserSelectionDialog​(boolean multiselect, int min, int max, boolean allowUsers, boolean allowGroups, UserName[] currentUsers, boolean onlyDisplayableUsers, boolean suppressOwnUser)
    Zeigt einen Dialog zur Auswahl von Anwendern und/oder Gruppen.
    void showView​(String viewName)
    Aktiviert eine Kachel anhand des Namens
    BackgroundJob startBackgroundProcess​(String jobTypeName, String backgroundFunction)
    Erzeugt einen neuen Hintergrundprozess im Client, welcher die angegebene Funktion ausführt.
    void startFunction​(int functionID)
    Deprecated.
    ersetzt durch startFunction(String)
    void startFunction​(String functionName)
    Startet die Funktion mit dem angegebenen Namen.
    void toFront()
    Bringt das Workspace-Fenster in den Vordergrund.
    void updateEnabledFunctions()
    Aktualisiert den Enabled Zustand der Ribbon Buttons.
    void updateKeywords()
    Lädt die Stichwortlisten (der Verschlagwortung) neu vom IndexServer.
    void updateMasks()
    Lädt die Verschlagwortungsmasken neu vom IndexServer.
    void updateScripts()
    Läde die Skripte neu vom Server.
    void updateSordLists()
    Löscht den internen Sord List Cache
    void updateUsers()
    Lädt die Anwender (und Anwendergruppen) neu vom IndexServer.

    Methods inherited from class Object

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

  • Constructor Details

    • WorkspaceAdapter

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

  • Method Details

    • setPageCachePage

      public void setPageCachePage​(int objectId, int page, boolean onlyIfNew)
      Setzt die Seitennummer zu einem Eintrag im PageCache. Wenn dieses Dokument das nächste mal angezeigt wird, wird direkt diese Seite aufgeblättert.
      Parameters:
      objectId - Objekt-Id
      page - Zielseite, 1-Index basiert.
      onlyIfNew - Nur eintragen, wenn es noch keinen Eintrag gibt.
      Since:
      10.00.000

    • setRibbonTab

      public boolean setRibbonTab​(String tabName)
      Schaltet auf einen ausgewählten Ribbon-Tab um. Es werden die gleichen Tab-Namen wie in der Button-Definition verwendet (settings, home, document, archive, view, workflow...)
      Parameters:
      tabName - Scripting-Id des Tabs
      Returns:
      True, wenn der Tab gefunden wurde.
      Since:
      10.00.000

    • addHotKey

      public void addHotKey​(String keyName, String eventName)
      Registriert eine Skriptfunktion zum Aufruf über einen HotKey.
      Parameters:
      keyName - Name der Taste im Java KeyStroke Format
      eventName - Name der Callback Funktion
      Since:
      10.01.000, 10.09.000, 11.03.000 IllegalArgumentException bei ungültigem KeyStroke-Verweis

    • selectStoreTile

      public Sord selectStoreTile() throws RemoteException
      Zeigt eine Übersicht aller Kacheln im lokalen Store. Wenn der Anwender einen Eintrag selektiert, wird das zugehörende Sord Objekt zurückgegeben. Wenn der Anwender die Aktion abbricht, wird null zurückgegeben.
      Returns:
      Ausgewähltes Objekt oder null
      Throws:
      RemoteException - Wenn die Kacheln nicht gelesen werden können.
      Since:
      10.00.000

    • publishStoreTile

      public int publishStoreTile​(int sourceId) throws Exception
      Zeigt eine Liste aller Store-Bereiche an in denen der Anwender Einträge einfügen darf. Wenn der Anwender ein Ziel auswählt, wird die als Parameter übergebene Kachel in diesen Ordner kopiert.
      Parameters:
      sourceId - Zu kopierende Kachel
      Returns:
      neue Objekt-Id
      Throws:
      Exception - Wenn die Kachel nicht kopiert werden kann.
      Since:
      10.00.000

    • addReportEntry

      public void addReportEntry​(int objid, int actionNo, int extra1, int extra2, String message) throws Exception
      Schreibt einen Report Eintrag in die Datenbank. Die actionNo muss im Bereich von 3000 bis 3999 liegen.
      Parameters:
      objid - ELO Objekt zu dem der Reporteintrag geschrieben werden soll
      actionNo - Aktionsnummer, Anwenderdefiniert, 3000...3999
      extra1 - Datenbankfeld extra1
      extra2 - Datenbankfeld extra2
      message - Kommentarfeld
      Throws:
      Exception - Wenn der Reporteintrag nicht angelegt werden kann.
      Since:
      9.02.000

    • toFront

      public void toFront()
      Bringt das Workspace-Fenster in den Vordergrund.
      Since:
      8.04.000

    • hasModalDialogOpened

      public boolean hasModalDialogOpened()
      Meldet zurück, ob ein modaler Dialog offen ist.
      Returns:
      TRUE, falls ein modaler Dialog angezeigt wird.
      Since:
      9.02.000

    • getLastInsertedDocument

      public int getLastInsertedDocument()
      Liefert die Id des zuletzt abgelegten Dokumentes zurück.
      Returns:
      Objekt-ID
      Since:
      9.03.000

    • getUserNodeId

      public int getUserNodeId()
      Liefert die ELO ObjectId des Anwenderordners zurück.
      Returns:
      objid
      Since:
      10.00.000

    • getUserPersonalNodeId

      public int getUserPersonalNodeId()
      Liefert die ELO ObjectId des persönlichen Anwenderordners zurück.
      Returns:
      objid
      Since:
      10.00.000

    • doImport

      public String doImport​(String sourcePath, int targetId, int guidMethod, long flags) throws IllegalArgumentException, RemoteException
      Führt einen Importvorgang mit den angegebenen Parametern durch. Der Parameter guidMethod kann einen Wert aus ImportOptionsC enthalten. Hier können die Konstanten, welche mit GUID_ beginnen, verwendet werden. Dieser Wert wird an die IX Funktion startImport im Parameter guidMethod übergeben. Der Parameter flags enthält die Werte für den startImport Aufrufparameter options.
      Parameters:
      sourcePath - Pfad unter dem die zu importierende Datei liegt
      targetId - Archivziel, in dem importiert wird
      guidMethod - Methode für das Vergeben der GUIDs
      flags - Optionen für den Importvorgang
      Returns:
      Import Ticket für die Abfrage des JobStates
      Throws:
      RemoteException - Wenn der Serverprozess nicht gestartet werden kann.
      IllegalArgumentException - Bei fehlerhaften Parametern.
      Since:
      9.01.000

    • gotoId

      public boolean gotoId​(int objId)
      Springt im Archiv an das Element mit der angegebenen ObjektID.
      Parameters:
      objId - Objekt Id des Archivelements
      Returns:
      True wenn die objId gefunden wurde, sonst False

    • gotoWorkflow

      public boolean gotoWorkflow​(int flowId, int nodeId)
      Wechselt in die Aufgabenansicht und zeigt den angegebenen Workflow an. Die Angabe der nodeId ist optional und nur sinnvoll, wenn ein Anwender mehrere aktive Knoten des gleichen Workflows haben kann und diese unterschieden werden sollen. Wenn die nodeId 0 ist, wird der erste passende Workfloweintrag selektiert.
      Parameters:
      flowId - Workflow-Id
      nodeId - Knoten-Id
      Returns:
      True, wenn der Workflow gefunden und angesprungen wurde
      Since:
      11.00.000

    • gotoGuid

      public boolean gotoGuid​(String guid)
      Springt im Archiv an das Element mit der angegebenen Objekt-GUID. Optional kann man noch eine Seitennummer oder eine Annotation ID mitgeben. Die Anzeige springt dann auf die entsprechende Seite. gotoGuid( "(714466C2-7B76-715A-FD76-9D27C703EE7E)@A5041" ); Es kann auch eine Liste von GUIDs angegeben werden. In diesem Fall werden die Einträge in der Such-Trefferliste angezeigt. Eine Seiten- markierung ist in diesem Fall nicht möglich.
      Parameters:
      guid - GUID oder GUID-Liste
      Returns:
      True wenn die objId gefunden wurde, sonst False
      Since:
      9.02.000

    • getActiveView

      public ViewAdapter getActiveView()
      Liefert einen Adapter für die aktuelle Ansicht zurück.
      Returns:
      ViewAdapter Adapter für die aktuelle Ansicht

    • showView

      public void showView​(String viewName)
      Aktiviert eine Kachel anhand des Namens
      Parameters:
      viewName - Name der Kachel
      Since:
      11.00.000

    • showTasksView

      public void showTasksView() throws NavigationViewNotFoundException
      Zeigt den Funktionsbereicht "Aufgaben".
      Throws:
      NavigationViewNotFoundException - Wenn keine Aufgabenansicht gefunden wurde.

    • showArchiveView

      public void showArchiveView() throws NavigationViewNotFoundException
      Zeigt den Funktionsbereicht "Archiv".
      Throws:
      NavigationViewNotFoundException - Wenn keine Archivansicht gefunden wurde.

    • showCheckoutView

      public void showCheckoutView() throws NavigationViewNotFoundException
      Zeigt den Funktionsbereicht "In Bearbeitung".
      Throws:
      NavigationViewNotFoundException - Wenn "In Bearbeitung" nich gefunden wurde.

    • showClipboardView

      public void showClipboardView() throws NavigationViewNotFoundException
      Zeigt den Funktionsbereicht "Klemmbrett".
      Throws:
      NavigationViewNotFoundException - Wenn kein Klemmbrett gefunden wurde.

    • showIntrayView

      public void showIntrayView() throws NavigationViewNotFoundException
      Zeigt den Funktionsbereicht "Postbox".
      Throws:
      NavigationViewNotFoundException - Wenn keine Postbox gefunden wurde.

    • showSearchView

      public void showSearchView() throws NavigationViewNotFoundException
      Zeigt den Funktionsbereicht "Suche".
      Throws:
      NavigationViewNotFoundException - Wenn keine Suchansicht gefunden wurde.

    • showMyEloView

      public void showMyEloView() throws NavigationViewNotFoundException
      Zeigt den Funktionsbereich "Mein ELO".
      Throws:
      NavigationViewNotFoundException - Wenn "Mein ELO" nicht gefunden wurde.
      Since:
      9.02.001

    • startFunction

      public void startFunction​(int functionID)
      Deprecated.
      ersetzt durch startFunction(String)
      Startet die Funktion mit der angegebenen ID.
      Parameters:
      functionID - Funktionsnummer der zu startenden Client-Funktion

    • startFunction

      public void startFunction​(String functionName) throws Exception
      Startet die Funktion mit dem angegebenen Namen.
      Parameters:
      functionName - Funktionsname der zu startenden Client-Funktion
      Throws:
      Exception - Falls keine Funktion mit diesem Namen vorhanden ist
      Since:
      7.00.006

    • isFunctionEnabled

      public boolean isFunctionEnabled​(int functionID)
      Deprecated.
      ersetzt durch isFunctionEnabled(String)
      Prüft ob die Funktion mit der angegebenen Funktionsnummer im derzeitigen Zustand des Clients (aktiver Funktionsbereich, aktuelle Selektion...) verfügbar ist.
      Parameters:
      functionID - Id/Nummer der zu prüfenden Client-Funktion
      Returns:
      True wenn die Funktion verfügbar ist, sonst False
      Since:
      6.00.088

    • isFunctionEnabled

      public boolean isFunctionEnabled​(String functionName)
      Prüft ob die Funktion mit dem angegebenen Funktionsnamen im derzeitigen Zustand des Clients (aktiver Funktionsbereich, aktuelle Selektion...) verfügbar ist.
      Parameters:
      functionName - Name der zu startenden Client-Funktion
      Returns:
      True wenn die Funktion verfügbar ist, sonst False
      Since:
      7.00.008

    • updateSordLists

      public void updateSordLists()
      Löscht den internen Sord List Cache
      Since:
      8.01.000

    • getDocMask

      public DocMask getDocMask​(String maskName) throws Exception
      Liefert das Indexserver Objekt DocMask zu einem Maskennamen zurück.
      Parameters:
      maskName - Maskenname
      Returns:
      Indexserver Objekt DocMask
      Throws:
      Exception - Wenn die Maske nicht vom Server gelesen werden kann.
      Since:
      8.04.000

    • updateKeywords

      public void updateKeywords()
      Lädt die Stichwortlisten (der Verschlagwortung) neu vom IndexServer.

    • updateMasks

      public void updateMasks()
      Lädt die Verschlagwortungsmasken neu vom IndexServer.

    • updateUsers

      public void updateUsers()
      Lädt die Anwender (und Anwendergruppen) neu vom IndexServer.

    • updateEnabledFunctions

      public void updateEnabledFunctions()
      Aktualisiert den Enabled Zustand der Ribbon Buttons.
      Since:
      10.000.008

    • updateScripts

      public void updateScripts()
      Läde die Skripte neu vom Server. Skripte, welche sich gerade in Bearbeitung durch den Benutzers befinden (also von ihm ausgechecked sind und im Funktionsbereich "In Bearbeitung" liegen), werden lokal geladen. Somit ist es zum Testen von Skripten nicht nötig, diese erst einzuchecken. Sie können lokal bearbeitet und getestet werden.

    • showInfoBox

      public void showInfoBox​(String title, String text)
      Zeigt einen Informationsdialog mit den angegebenen Titel und Text. Dieser besitzt nur den Button "OK".
      Parameters:
      title - Dialogtitel (wird im Fensterrand angezeigt)
      text - Beschreibungstext des Dialogs

    • showAlertBox

      public void showAlertBox​(String title, String text)
      Zeigt einen Warndialog mit den angegebenen Titel und Text. Dieser besitzt nur den Button "OK".
      Parameters:
      title - Dialogtitel (wird im Fensterrand angezeigt)
      text - Beschreibungstext des Dialogs

    • showQuestionBox

      public boolean showQuestionBox​(String title, String text)
      Zeigt einen Fragedialog mit den angegebenen Titel und Text. Dieser besitzt die Buttons "Ja" und "Nein". Die Methode liefert entsprechend true oder false zurück.
      Parameters:
      title - Dialogtitel (wird im Fensterrand angezeigt)
      text - Beschreibungstext des Dialogs
      Returns:
      True bei angeklicktem "Ja", sonst False

    • showSimpleInputBox

      public String showSimpleInputBox​(String title, String text, String defaultValue)
      Zeigt eine Input Box an. Fenstertitel, Messagetext und Vorgabewert der Eingabe können übergeben werden. Wenn der Anwender mit Abbruch beendet, wird ein Null Wert zurück gegeben
      Parameters:
      title - Fenstertitel
      text - Hinweistext, mehrzeiliger Fließtext erlaubt.
      defaultValue - Vorgabewert für das Eingabefeld
      Returns:
      Eingabetext oder null
      Since:
      8.01.000

    • showInputBox

      public String showInputBox​(String title, String text, String defaultValue, int minLength, int maxLength, boolean isPwdDialog, int alignment)
      Zeigt eine Input Box an. Fenstertitel, Messagetext und Vorgabewert der Eingabe können übergeben werden. Wenn der Anwender mit Abbruch beendet, wird ein Null Wert zurück gegeben
      Parameters:
      title - Fenstertitel
      text - Hinweistext, mehrzeiliger Fließtext erlaubt.
      defaultValue - Vorgabewert für das Eingabefeld
      minLength - Minimale Eingabelänge (-1 für keine Beschränkung)
      maxLength - Maximale Eingabelänge (-1 für keine Beschränkung)
      isPwdDialog - True, wenn eine Passworteingabe verwendet werden soll.
      alignment - -1: Standard verwenden, 0: Mittig, 2: Links, 4: Rechts
      Returns:
      Eingabetext oder null
      Since:
      8.01.000

    • getWorkspace

      public Workspace getWorkspace()
      Deprecated.
      Diese Funktion macht interne Klassen des Clients sichtbar. Diese können sich jederzeit ohne öffentliche Dokumentation ändern und sollten daher nicht im Scripting verwendet werden.
      Liefert das interne Workspace-Objekt(Arbeitsbereich) des Clients.
      Returns:
      Workspace

    • getUserName

      public String getUserName()
      Liefert den Namen des aktuell am Client angemeldeten Benutzers.
      Returns:
      String Anwendername
      Since:
      6.00.088

    • getUserId

      public int getUserId()
      Liefert die Id des aktuell angemeldeten Anwenders zurück oder -1 wenn kein Anwender angemeldet ist.
      Returns:
      int
      Since:
      8.00.000

    • getDirectories

      public DirectoriesAdapter getDirectories()
      Liefert ein Objekt für den Zugriff auf die lokalen Client Verzeichnisse.
      Returns:
      DirectoriesAdapter Adapter für die lokalen Verzeichnisse
      Since:
      8.00.000

    • getUserRights

      public UserRightsAdapter getUserRights()
      Liefert ein Objekt für den Zugriff auf die Anwenderrechte.
      Returns:
      UserRightsAdapter Adapter für die Anwenderrechte
      Since:
      8.00.000

    • getUserGroups

      public int[] getUserGroups()
      Liefert eine Liste aller Gruppen des aktuellen Anwenders zurück
      Returns:
      Liste der User-IDs aller Gruppen
      Since:
      8.03.000

    • getUserGroupNames

      public String[] getUserGroupNames()
      Liefert eine Liste aller Gruppen des aktuellen Anwenders zurück

      Kann eine der Gruppen, z.B. auf auf Grund der Organisationseinheit, nicht gelesen werden, wird diese mit null hinterlegt.

      Returns:
      Liste der Namen aller Gruppen
      Since:
      8.03.002

    • isMemberOf

      public boolean isMemberOf​(String idOrName)
      Meldet zurück, ob der aktuelle Anwender Mitglied einer Gruppe ist. Der Parameter kann eine Gruppen-Id oder einen Gruppennamen enthalten. Die Ermittlung des Gruppennamen ist nicht sehr effizient wenn eine größere Menge von Namen geprüft werden soll. In diesem Fall arbeitet man besser mit getUserGroupNames.
      Parameters:
      idOrName - Id oder Name der Gruppe
      Returns:
      True, wenn der Anwender ein Mitglied der Gruppe ist.
      Since:
      11.00.000

    • incCounter

      public int incCounter​(String counterName, int defaultValue)
      Zählt den angegebenen Counter um einen Wert hoch. Falls der Counter noch nicht existiert, wird er mit dem angegebenen default Wert angelegt.
      Parameters:
      counterName - Name des Counters
      defaultValue - Defaultwert falls der Counter neu angelegt werden muss
      Returns:
      int Inkrementierter Wert, -1 wenn der Counter nicht gelesen oder erstellt werden konnte.

    • lookupMaskId

      public int lookupMaskId​(String maskName)
      Deprecated.
      Ersetzt durch ArchiveAdapter.lookupMaskId(String)
      Ermittelt die Maskennummer zu dem angegebenen Maskennamen.
      Parameters:
      maskName - gesuchte Maske
      Returns:
      Nummer der gesuchten Maske
      Since:
      6.00.100

    • sendHttpRequest

      public String sendHttpRequest​(String url) throws IOException
      Sendet eine HTTP Anfrage und liefert die Response.
      Parameters:
      url - Adresse für die HTTP-Anfrage
      Returns:
      String HTTP Response
      Throws:
      IOException - Bei Netzwerkfehlern

    • createGridDialog

      public GridDialog createGridDialog​(String title, int columns, int rows)
      Erzeugt einen Dialog mit einem Tabellenlayout. In diesem können Eingabefelder definiert und abgefragt werden. Zur Anzeige des Dialogs muss dessen Methode show() aufgerufen werden.
      Parameters:
      title - Dialogtitel (wird im Fensterrand angezeigt)
      columns - Anzahl der Spalten im Tabellenraster
      rows - Anzahl der Zeilen im Tabellenraster
      Returns:
      GridDialog Der erzeugte GridDialog
      Since:
      7.00.004

    • createAppDialog

      public AppDialog createAppDialog​(String title)
      Erzeugt einen Dialog in welchem Webanwendungen geladen werden können.

      Achtung: Diese Methode wird von der Internet Explorer Integration im Notes Client nicht unterstützt.

      Parameters:
      title - Dialogtitel (wird im Fensterrand angezeigt)
      Returns:
      Der erzeugte AppDialog
      Since:
      9.03.000

    • showUserSelectionDialog

      public UserName[] showUserSelectionDialog​(boolean multiselect, int min, int max, boolean allowUsers, boolean allowGroups) throws Exception
      Zeigt einen Dialog zur Auswahl von Anwendern und/oder Gruppen.
      Parameters:
      multiselect - Bei True ist Mehrfachauswahl in der linken Anwenderliste erlaubt, bei False kann nur ein Anwender oder eine Gruppe zur Zeit ausgewählt werden.
      min - Minimale Anzahl an Anwendern/Gruppen die selektiert sein müssen
      max - Maximale Anzahl an Anwendern/Gruppen die selektiert sein dürfen
      allowUsers - True damit Anwender ausgewählt werden dürfen, False wenn nicht
      allowGroups - True damit Gruppen ausgewählt werden dürfen, False wenn nicht
      Returns:
      UserName[] Liste mit den ausgewählten Anwender/Gruppen oder null wenn der Dialog abgebrochen wurde
      Throws:
      Exception - Exception Bei fehlerhaften Parametern.
      Since:
      7.00.004

    • showUserSelectionDialog

      public UserName[] showUserSelectionDialog​(boolean multiselect, int min, int max, boolean allowUsers, boolean allowGroups, UserName[] currentUsers) throws Exception
      Zeigt einen Dialog zur Auswahl von Anwendern und/oder Gruppen.
      Parameters:
      multiselect - Bei True ist Mehrfachauswahl in der linken Anwenderliste erlaubt, bei False kann nur ein Anwender oder eine Gruppe zur Zeit ausgewählt werden.
      min - Minimale Anzahl an Anwendern/Gruppen die selektiert sein müssen
      max - Maximale Anzahl an Anwendern/Gruppen die selektiert sein dürfen
      allowUsers - True damit Anwender ausgewählt werden dürfen, False wenn nicht
      allowGroups - True damit Gruppen ausgewählt werden dürfen, False wenn nicht
      currentUsers - Vorbelegung der Anwenderauswahl
      Returns:
      UserName[] Liste mit den ausgewählten Anwender/Gruppen oder null wenn der Dialog abgebrochen wurde
      Throws:
      Exception - Exception Bei fehlerhaften Parametern.
      Since:
      8.04.000

    • showUserSelectionDialog

      public UserName[] showUserSelectionDialog​(boolean multiselect, int min, int max, boolean allowUsers, boolean allowGroups, UserName[] currentUsers, boolean onlyDisplayableUsers) throws Exception
      Zeigt einen Dialog zur Auswahl von Anwendern und/oder Gruppen.
      Parameters:
      multiselect - Bei True ist Mehrfachauswahl in der linken Anwenderliste erlaubt, bei False kann nur ein Anwender oder eine Gruppe zur Zeit ausgewählt werden.
      min - Minimale Anzahl an Anwendern/Gruppen die selektiert sein müssen
      max - Maximale Anzahl an Anwendern/Gruppen die selektiert sein dürfen
      allowUsers - True damit Anwender ausgewählt werden dürfen, False wenn nicht
      allowGroups - True damit Gruppen ausgewählt werden dürfen, False wenn nicht
      currentUsers - Vorbelegung der Anwenderauswahl
      onlyDisplayableUsers - Nur sichtbare Anwender anzeigen
      Returns:
      UserName[] Liste mit den ausgewählten Anwender/Gruppen oder null wenn der Dialog abgebrochen wurde
      Throws:
      Exception - Exception Bei fehlerhaften Parametern.
      Since:
      9.02.000

    • showUserSelectionDialog

      public UserName[] showUserSelectionDialog​(boolean multiselect, int min, int max, boolean allowUsers, boolean allowGroups, UserName[] currentUsers, boolean onlyDisplayableUsers, boolean suppressOwnUser) throws Exception
      Zeigt einen Dialog zur Auswahl von Anwendern und/oder Gruppen.
      Parameters:
      multiselect - Bei True ist Mehrfachauswahl in der linken Anwenderliste erlaubt, bei False kann nur ein Anwender oder eine Gruppe zur Zeit ausgewählt werden.
      min - Minimale Anzahl an Anwendern/Gruppen die selektiert sein müssen
      max - Maximale Anzahl an Anwendern/Gruppen die selektiert sein dürfen
      allowUsers - True damit Anwender ausgewählt werden dürfen, False wenn nicht
      allowGroups - True damit Gruppen ausgewählt werden dürfen, False wenn nicht
      currentUsers - Vorbelegung der Anwenderauswahl
      onlyDisplayableUsers - Nur sichtbare Anwender anzeigen
      suppressOwnUser - Eigenen Anwender nicht anzeigen
      Returns:
      UserName[] Liste mit den ausgewählten Anwender/Gruppen oder null wenn der Dialog abgebrochen wurde
      Throws:
      Exception - Bei fehlerhaften Parametern.
      Since:
      9.03.000

    • showUserSelectionDialog

      public UserName[] showUserSelectionDialog​(boolean multiselect, int min, int max, boolean allowUsers, boolean allowGroups, boolean allowOptionGroups, UserName[] currentUsers, boolean onlyDisplayableUsers, boolean suppressOwnUser) throws Exception
      Zeigt einen Dialog zur Auswahl von Anwendern und/oder Gruppen.
      Parameters:
      multiselect - Bei True ist Mehrfachauswahl in der linken Anwenderliste erlaubt, bei False kann nur ein Anwender oder eine Gruppe zur Zeit ausgewählt werden.
      min - Minimale Anzahl an Anwendern/Gruppen die selektiert sein müssen
      max - Maximale Anzahl an Anwendern/Gruppen die selektiert sein dürfen
      allowUsers - True damit Anwender ausgewählt werden dürfen, False wenn nicht
      allowGroups - True damit Gruppen ausgewählt werden dürfen, False wenn nicht
      allowOptionGroups - True damit Optionengruppen ausgewählt werden dürfen, False wenn nicht
      currentUsers - Vorbelegung der Anwenderauswahl
      onlyDisplayableUsers - Nur sichtbare Anwender anzeigen
      suppressOwnUser - Eigenen Anwender nicht anzeigen
      Returns:
      UserName[] Liste mit den ausgewählten Anwender/Gruppen oder null wenn der Dialog abgebrochen wurde
      Throws:
      Exception - Bei fehlerhaften Parametern.
      Since:
      10.04.000

    • showUserSelectionDialog

      public UserName[] showUserSelectionDialog​(boolean multiselect, int min, int max, boolean allowUsers, boolean allowGroups, boolean allowOptionGroups, boolean allowGlobal, UserName[] currentUsers, boolean onlyDisplayableUsers, boolean suppressOwnUser) throws Exception
      Zeigt einen Dialog zur Auswahl von Anwendern und/oder Gruppen.
      Parameters:
      multiselect - Bei True ist Mehrfachauswahl in der linken Anwenderliste erlaubt, bei False kann nur ein Anwender oder eine Gruppe zur Zeit ausgewählt werden.
      min - Minimale Anzahl an Anwendern/Gruppen die selektiert sein müssen
      max - Maximale Anzahl an Anwendern/Gruppen die selektiert sein dürfen
      allowUsers - True damit Anwender ausgewählt werden dürfen, False wenn nicht
      allowGroups - True damit Gruppen ausgewählt werden dürfen, False wenn nicht
      allowOptionGroups - True damit Optionengruppen ausgewählt werden dürfen, False wenn nicht
      allowGlobal - True damit "Jeder" ausgewählt werden darf, False wenn nicht
      currentUsers - Vorbelegung der Anwenderauswahl
      onlyDisplayableUsers - Nur sichtbare Anwender anzeigen
      suppressOwnUser - Eigenen Anwender nicht anzeigen
      Returns:
      UserName[] Liste mit den ausgewählten Anwender/Gruppen oder null wenn der Dialog abgebrochen wurde
      Throws:
      Exception - Bei fehlerhaften Parametern.
      Since:
      12.00.000

    • showPermissionsDialog

      public AclItem[] showPermissionsDialog​(String dialogTitle, AclItem[] currentPermissions)
      Zeigt einen Dialog zur Auswahl/Einstellung von Berechtigungen.
      Parameters:
      dialogTitle - Titel des Dialogs
      currentPermissions - Aktuell gesetzte Berechtigungen / Vorauswahl der Berechtigungen
      Returns:
      AclItem[] Liste mit den ausgewählten Berechtigungen
      Since:
      8.01.004

    • showCommandLinkDialog

      public int showCommandLinkDialog​(String dlgTitel, String dlgHeader, String dlgText, CONSTANTS.DIALOG_ICON dlgIcon, String[] optionNames, String[] optionDescriptions, ArchiveDocument[] optionIcons) throws Exception
      Zeiget einen Dialog mit mehreren CommandLinks an.
      Parameters:
      dlgTitel - Dialogtitel
      dlgHeader - Dialogheader
      dlgText - Weiterer Dialogbeschreibungstext
      dlgIcon - Dialogicon
      optionNames - Liste mit den einzelnen Optionen
      optionDescriptions - Liste mit den Beschreibungen der Optionen
      optionIcons - Liste mit Icons für die einzelnen Optionen oder null für das Standardicon. Die Icons sollen ICO-Dateien oder 32x32 Pixel große PNG-Dateien mit Alpha-Transparenz sein.
      Returns:
      Nummer der Auswahl (Zählung beginnt bei 1) oder -1 bei "Abbrechen" oder -2 bei ungültigen Parameterangaben
      Throws:
      Exception - Wenn Icons nicht geladen werden können.
      Since:
      8.04.000, 9.02.000 ICO Unterstützung, vorher nur PNG

    • getLanguage

      public String getLanguage()
      Liefert die eingestellte Sprache des Clients, z.B. "de" für Deutsch oder "en" für Englisch.
      Returns:
      String Sprachcode laut ISO 639 in Kleinbuchstaben
      Since:
      7.00.004

    • getClientVersion

      public String getClientVersion()
      Liefert die Versionsnummer dieses Clients.
      Returns:
      Versionsnummer, z.B. "8.04.000"
      Since:
      8.04.000

    • getConnectionNumber

      public int getConnectionNumber()
      Liefert zurück, in welcher Ansicht (0 oder 1) das Skript gerade läuft.
      Returns:
      Ansicht-Nummer
      Since:
      9.01.000

    • sendBroadcast

      public void sendBroadcast​(CONSTANTS.DESTINATION_WORKSPACE destination, String tag, String message)
      Sendet eine Nachricht an dem angegebenen Workspace.
      Parameters:
      destination - Workspace, an dem die Nachricht gesendet wird
      tag - Titel der Nachricht
      message - Inhalt der Nachricht
      Since:
      9.01.000

    • sendMail

      public void sendMail​(String subject, String receiver, String content, String[] attachNames) throws Exception
      Versendet eine Mail
      Parameters:
      subject - Betreff
      receiver - Empfängeradresse
      content - (HTML) Mailkörper
      attachNames - Liste der Attachment-Dateinamen
      Throws:
      Exception - Wenn beim Zugriff auf das E-Mail Programm Fehler auftreten.
      Since:
      9.01.003

    • setStatusMessage

      public void setStatusMessage​(String messageText)
      Setzt den angegebenen Text in der Statuszeile des Java Client.
      Parameters:
      messageText - Der in der Statuszeile anzuzeigende Text.
      Since:
      7.00.006

    • setSyncCallback

      public void setSyncCallback​(String callbackName)
      Setzt den Namen der Callback Funktion in der MobileSync Behandlung.
      Parameters:
      callbackName -
      Since:
      12.00.002

    • setFeedbackMessage

      public void setFeedbackMessage​(String messageText)
      Setzt einen Text welcher kurz im Workspace eingeblendet wird. Diese Methodik sollte für kurze Rückmeldungen an den Benutzer verwendet werden, z.B. "Workflow gestartet". Solch eine Rückmeldung ist immer dann sinnvoll, wenn ein komplexerer Vorgang stattfindet, bei dem der Anwender nicht direkt erkennen kann, dass seine Aktion erfolgreich war.
      Parameters:
      messageText - Der anzuzeigende Text.
      Since:
      7.00.022 / 8.00.002

    • setFeedbackMessage

      public void setFeedbackMessage​(CONSTANTS.FEEDBACK_TYPE type, String messageText)
      Setzt einen Text welcher kurz im Workspace eingeblendet wird. Diese Methodik sollte für kurze Rückmeldungen an den Benutzer verwendet werden, z.B. "Workflow gestartet". Solch eine Rückmeldung ist immer dann sinnvoll, wenn ein komplexerer Vorgang stattfindet, bei dem der Anwender nicht direkt erkennen kann, dass seine Aktion erfolgreich war.
      Parameters:
      type - Art des Feedbacks.
      messageText - Der anzuzeigende Text.
      Since:
      10.00.000

    • showTreeSelectDialog

      public int showTreeSelectDialog​(String title, String message, int rootId, boolean documentsSelectable, boolean folderSelectable, boolean showFavorites)
      Zeigt einen Dialog zur Auswahl eines Ordners oder Dokuments im Archiv an.
      Parameters:
      title - Dialogtitel
      message - Eine Nachricht, welche über dem Baum angezeigt wird
      rootId - ObjektID des Startknotens, 1 für den Archivanfang
      documentsSelectable - Definiert, ob Dokumente ausgewählt werden können
      folderSelectable - Definiert, ob Ordner ausgewählt werden können
      showFavorites - True, wenn die Liste mit "Favoriten" und "Zuletzt benutzt" angezeigt werden soll
      Returns:
      int ObjektID des selektierten Eintrags oder -1 falls der Dialog abgebrochen wurde
      Since:
      7.00.006

    • showTreeSelectDialog

      public int showTreeSelectDialog​(String title, String message, int rootId, boolean documentsSelectable, boolean folderSelectable, boolean showFavorites, boolean showAddFolderButton, int selectedId)
      Zeigt einen Dialog für die Auswahl eines Archiveintrags an.
      Parameters:
      title - Dialogtitel
      message - Ein Beschreinungstext, der über dem Baum angezeigt wird
      rootId - ObjektID des Startknotens, 1 für den Archivanfang
      documentsSelectable - Definiert, ob Dokumente ausgewählt werden können
      folderSelectable - Definiert, ob Ordner ausgewählt werden können
      showFavorites - Definiert, ob die Liste mit den Favoriten angezeigt wird
      showAddFolderButton - Button für neue Ordner anzeigen
      selectedId - Id des ausgewählten Archiveintrags
      Returns:
      ObjektID des selektierten Eintrags oder -1 falls der Dialog abgebrochen wurde
      Since:
      9.01.000

    • showTreeSelectDialog

      public int showTreeSelectDialog​(String title, String message, int rootId, boolean documentsSelectable, boolean folderSelectable, boolean showFavorites, boolean showAddFolderButton, int selectedId, File sourceFile)
      Zeigt einen Dialog für die Auswahl eines Archiveintrags an.
      Parameters:
      title - Dialogtitel
      message - Ein Beschreinungstext, der über dem Baum angezeigt wird
      rootId - ObjektID des Startknotens, 1 für den Archivanfang
      documentsSelectable - Definiert, ob Dokumente ausgewählt werden können
      folderSelectable - Definiert, ob Ordner ausgewählt werden können
      showFavorites - Definiert, ob die Liste mit den Favoriten angezeigt wird
      showAddFolderButton - Button für neue Ordner anzeigen
      selectedId - Id des ausgewählten Archiveintrags
      sourceFile - Datei als Informationsquelle für Zielvorschläge
      Returns:
      ObjektID des selektierten Eintrags oder -1 falls der Dialog abgebrochen wurde
      Since:
      10.01.000

    • getHintManager

      public HintManager getHintManager()
      Deprecated.
      Liefert den zuletzt verwendeten HintManager zurück. Dieser Wert kann null sein, wenn keine Datei übergeben wurde. Der HintManager wird von der Funktion showTreeSelectDialog erzeugt und gefüllt.
      Returns:
      Hintmanager aus der letzten Verwendung von showTreeSelectDialog(String, String, int, boolean, boolean, boolean, boolean, int, File)
      Since:
      10.01.000

    • sendELOasRequest

      public void sendELOasRequest​(String serverName, int port, String serviceName, boolean withTicket, String rulesetName, String param1, String param2, String param3) throws Exception
      Deprecated.
      Dieser Aufruf hat einen Fehler, der serviceName muss mit "/" beginnen, damit er funktioniert. Ersetzt durch runELOas(String, int, String, boolean, boolean, String, String...) mit korrigiertem serviceNamen.
      Aufruf eine ELOas Ruleset.
      Parameters:
      serverName - Name oder IP Adresse des ELOas Servers.
      port - Portnummer des ELOas Servers. Im Normalfall 8080, Standard http Port.
      serviceName - Servicename des ELOas Servers. In einer Standardinstallation setzt er sich aus dem Präfix as- und dem Archivnamen zusammen (z.B. as-ELO). Dabei ist unbedingt auf die korrekte Groß/ Kleinschreibweise zu achten, andernfalls meldet der Tomcat Server einen Fehler.
      withTicket - False: keine Anmeldeinformation mit senden; True: aktuelles Ticket als Anmeldeinformation mit senden. In diesem Fall prüft der ELOas das Ticket und ermittelt hieraus die Anwendernummer. Diese Information wird dann dem Ruleset zur Verfügung gestellt. Im Ruleset kann dann entschieden werden, ob und in welchen Umfang die Aktion ausgeführt wird.
      rulesetName - Name des auszuführenden Ruleset. Es können nur getriggerte Rulesets aufgerufen werden. Bei intervallgesteuerten Rulesets wird der Aufruf ignoriert.
      param1 - Erster Parameter. Dieser Parameter wird, wenn er nicht leer ist, als Suchbegriff für die Ruleset Ausführung verwendet.
      param2 - Weiterer, optionaler Parameter. Dieser kann vom Ruleset abgefragt werden und die Ausführung steuern.
      param3 - Weiterer, optionaler Parameter. Dieser kann vom Ruleset abgefragt werden und die Ausführung steuern.
      Throws:
      Exception - Wenn der Zugriff auf den ELOas nicht ausgeführt werden konnte.
      Since:
      7.00.006

    • runELOas

      public int runELOas​(String serverName, int port, String serviceName, boolean withTicket, String rulesetName, String param1, String param2, String param3) throws Exception
      Aufruf eine ELOas Ruleset. Dieses wird dann vom ELOas asynchron aufgerufen.
      Parameters:
      serverName - Name oder IP Adresse des ELOas Servers.
      port - Portnummer des ELOas Servers. Im Normalfall 8080, Standard http Port.
      serviceName - Servicename des ELOas Servers. In einer Standardinstallation setzt er sich aus dem Präfix as- und dem Archivnamen zusammen (z.B. as-ELO). Dabei ist unbedingt auf die korrekte Groß/ Kleinschreibweise zu achten, andernfalls meldet der Tomcat Server einen Fehler.
      withTicket - False: keine Anmeldeinformation mit senden; True: aktuelles Ticket als Anmeldeinformation mit senden. In diesem Fall prüft der ELOas das Ticket und ermittelt hieraus die Anwendernummer. Diese Information wird dann dem Ruleset zur Verfügung gestellt. Im Ruleset kann dann entschieden werden, ob und in welchen Umfang die Aktion ausgeführt wird.
      rulesetName - Name des auszuführenden Ruleset. Es können nur getriggerte Rulesets aufgerufen werden. Bei intervallgesteuerten Rulesets wird der Aufruf ignoriert.
      param1 - Erster Parameter. Dieser Parameter wird, wenn er nicht leer ist, als Suchbegriff für die Ruleset Ausführung verwendet.
      param2 - Weiterer, optionaler Parameter. Dieser kann vom Ruleset abgefragt werden und die Ausführung steuern.
      param3 - Weiterer, optionaler Parameter. Dieser kann vom Ruleset abgefragt werden und die Ausführung steuern.
      Returns:
      HTTP Statuscode
      Throws:
      Exception - Wenn der Zugriff auf den ELOas nicht ausgeführt werden konnte.
      Since:
      8.00.008

    • runELOas

      public int runELOas​(String serverName, int port, String serviceName, boolean withTicket, boolean useSSL, String rulesetName, String... params) throws Exception
      Aufruf eine ELOas Ruleset. Dieses wird dann vom ELOas asynchron aufgerufen.
      Parameters:
      serverName - Name oder IP Adresse des ELOas Servers.
      port - Portnummer des ELOas Servers. Im Normalfall 8080, Standard http Port.
      serviceName - Servicename des ELOas Servers. In einer Standardinstallation setzt er sich aus dem Präfix as- und dem Archivnamen zusammen (z.B. as-ELO). Dabei ist unbedingt auf die korrekte Groß/ Kleinschreibweise zu achten, andernfalls meldet der Tomcat Server einen Fehler.
      withTicket - False: keine Anmeldeinformation mit senden; True: aktuelles Ticket als Anmeldeinformation mit senden. In diesem Fall prüft der ELOas das Ticket und ermittelt hieraus die Anwendernummer. Diese Information wird dann dem Ruleset zur Verfügung gestellt. Im Ruleset kann dann entschieden werden, ob und in welchen Umfang die Aktion ausgeführt wird.
      useSSL - True: Den Aufruf mit SSL verschlüsseln.
      rulesetName - Name des auszuführenden Ruleset. Es können nur getriggerte Rulesets aufgerufen werden. Bei intervallgesteuerten Rulesets wird der Aufruf ignoriert.
      params - Bis zu 10 Parameter Werte. Der erste Parameter wird, wenn er nicht leer ist, als Suchbegriff für die Ruleset Ausführung verwendet.
      Returns:
      HTTP Statuscode
      Throws:
      Exception - Wenn der Zugriff auf den ELOas nicht ausgeführt werden konnte.
      Since:
      9.02.000

    • getELOas

      public String getELOas​(String serverName, int port, String serviceName, boolean withTicket, String rulesetName, String param1, String param2, String param3) throws Exception
      Synchroner Aufruf eine ELOas Ruleset mit Rückgabewert.
      Parameters:
      serverName - Name oder IP Adresse des ELOas Servers.
      port - Portnummer des ELOas Servers. Im Normalfall 8080, Standard http Port.
      serviceName - Servicename des ELOas Servers. In einer Standardinstallation setzt er sich aus dem Präfix as- und dem Archivnamen zusammen (z.B. as-ELO). Dabei ist unbedingt auf die korrekte Groß/ Kleinschreibweise zu achten, andernfalls meldet der Tomcat Server einen Fehler.
      withTicket - False: keine Anmeldeinformation mit senden; True: aktuelles Ticket als Anmeldeinformation mit senden. In diesem Fall prüft der ELOas das Ticket und ermittelt hieraus die Anwendernummer. Diese Information wird dann dem Ruleset zur Verfügung gestellt. Im Ruleset kann dann entschieden werden, ob und in welchen Umfang die Aktion ausgeführt wird.
      rulesetName - Name des auszuführenden Ruleset. Es können nur getriggerte Rulesets aufgerufen werden. Bei intervallgesteuerten Rulesets wird der Aufruf ignoriert.
      param1 - Erster Parameter. Dieser Parameter wird, wenn er nicht leer ist, als Suchbegriff für die Ruleset Ausführung verwendet.
      param2 - Weiterer, optionaler Parameter. Dieser kann vom Ruleset abgefragt werden und die Ausführung steuern.
      param3 - Weiterer, optionaler Parameter. Dieser kann vom Ruleset abgefragt werden und die Ausführung steuern.
      Returns:
      ELOas Rückgabewert
      Throws:
      Exception - Wenn der Zugriff auf den ELOas nicht ausgeführt werden konnte.
      Since:
      8.00.008

    • getELOas

      public String getELOas​(String serverName, int port, String serviceName, boolean withTicket, boolean useSSL, String rulesetName, String... params) throws Exception
      Synchroner Aufruf eine ELOas Ruleset mit Rückgabewert.
      Parameters:
      serverName - Name oder IP Adresse des ELOas Servers.
      port - Portnummer des ELOas Servers. Im Normalfall 8080, Standard http Port.
      serviceName - Servicename des ELOas Servers. In einer Standardinstallation setzt er sich aus dem Präfix as- und dem Archivnamen zusammen (z.B. as-ELO). Dabei ist unbedingt auf die korrekte Groß/ Kleinschreibweise zu achten, andernfalls meldet der Tomcat Server einen Fehler.
      withTicket - False: keine Anmeldeinformation mit senden; True: aktuelles Ticket als Anmeldeinformation mit senden. In diesem Fall prüft der ELOas das Ticket und ermittelt hieraus die Anwendernummer. Diese Information wird dann dem Ruleset zur Verfügung gestellt. Im Ruleset kann dann entschieden werden, ob und in welchen Umfang die Aktion ausgeführt wird.
      useSSL - True: Den Aufruf mit SSL verschlüsseln.
      rulesetName - Name des auszuführenden Ruleset. Es können nur getriggerte Rulesets aufgerufen werden. Bei intervallgesteuerten Rulesets wird der Aufruf ignoriert.
      params - Bis zu 10 Parameter Werte. Der erste Parameter wird, wenn er nicht leer ist, als Suchbegriff für die Ruleset Ausführung verwendet.
      Returns:
      ELOas Rückgabewert
      Throws:
      Exception - Wenn der Zugriff auf den ELOas nicht ausgeführt werden konnte.
      Since:
      9.02.000

    • getFromUrl

      public String getFromUrl​(String url) throws IOException
      Aufruf eines http-Get mit der übergebenen URL. Das Ergebnis wird als String zurückgegeben. Die URL kann folgende Platzhalter enthalten: {ticket} {username} {userid} {archive} {server}
      Parameters:
      url - URL
      Returns:
      Response Content
      Throws:
      IOException - Wenn der HTTP Aufruf nicht funktioniert
      Since:
      11.01.000

    • getIndexPreview

      public IndexPreviewAdapter getIndexPreview()
      Deprecated.
      20.00
      Liefert ein Objekt zum Zugriff auf die Verschlagwortungsvorschau.
      Returns:
      Verschlagwortungsvorschau
      Since:
      7.00.022, 8.00.002

    • addView

      public ExtraView addView​(String viewName, boolean closeable, JComponent navigationComponent, JComponent topComponent)
      Fügt einen neuen Funktionsbereich in die Navigationsleiste ein.
      Parameters:
      viewName - Name des Funktionsbereichs, dieser wird auf dem Button angezeigt.
      closeable - True wenn der Funktionsbereich durch den Anwender entfernt werden kann, False wenn nicht.
      navigationComponent - Hauptkomponente in diesem Funktionsbereich
      topComponent - Toolbar-Komponente
      Returns:
      Neuer Funktionsbereich
      Since:
      8.01.000

    • removeView

      public void removeView​(String viewIdOrName)
      Entfernt einen zusätzlichen Funktionsbereich, welcher vorher über addView angelegt wurde.
      Parameters:
      viewIdOrName - Name oder ViewId (seit 8.04.000 und empfohlen) des zusätzlichen Funktionsbereichs.
      Since:
      8.01.000

    • setScriptButtonEnabled

      public void setScriptButtonEnabled​(int nr, boolean enabled)
      Setzt die Aktivierung eines ScriptButtons.
      Parameters:
      nr - Nummer des ScriptButtons (0 bis 999)
      enabled - True wenn der ScriptButton aktiv sein soll, False für inaktiv.
      Since:
      8.01.000

    • setScriptButtonEnabled

      public void setScriptButtonEnabled​(int nr, boolean document, boolean folder, boolean reminder, boolean workflow, boolean activity, boolean multiselect)
      Definiert eine Regel für die Aktivierung eines ScriptButtons.
      Parameters:
      nr - Nummer des ScriptButtons (0 bis 999)
      document - Aktivierung bei Dokumenten
      folder - Aktivierung bei Ordnern
      reminder - Aktivierung bei Wiedervorlagen
      workflow - Aktivierung bei Workflows
      activity - Aktivierung bei Aktivitäten
      multiselect - True für Aktivierung auch bei Mehrfachselektion, False für Aktivierung nur bei Einfachselektion
      Since:
      9.00.000

    • setScriptButtonEnabled

      public void setScriptButtonEnabled​(int nr, String functionName) throws Exception
      Koppelt die Aktivierung eines ScriptButtons an eine die Aktivierung einer Client-Funktion.
      Parameters:
      nr - Nummer des ScriptButtons (0 bis 999)
      functionName - Funktionsname der Basisfunktion an welche die Aktivierung gekoppelt werden soll
      Throws:
      Exception - Falls keine Funktion mit diesem Namen vorhanden ist
      Since:
      9.00.000

    • setWaitCursor

      public void setWaitCursor()
      Setzt den Warte-Mauszeiger.
      Since:
      8.01.000

    • setCookie

      public void setCookie​(String key, String value)
      Setzt ein Cookie im OleAutomation Interface.
      Parameters:
      key -
      value -
      Since:
      12.00.000

    • getCookie

      public String getCookie​(String key)
      Liefert den Wert eines Cookies aus dem Ole Automation Interface zurück.
      Parameters:
      key -
      Returns:
      Since:
      12.00.000

    • setNormalCursor

      public void setNormalCursor()
      Setzt den normalen Mauszeiger.
      Since:
      8.01.000

    • showFileChooserDialog

      public File[] showFileChooserDialog​(String dlgTitle, boolean saveMode, boolean selectOnlyFiles, String selectionPath)
      Zeigt einen Dialog für die Dateiauswahl an und liefert die selektierten Dateien oder Ordner zurück. Bei einem Dialogabbruch wird null zurückgeliefert.
      Parameters:
      dlgTitle - Dialogtitel
      saveMode - True wenn Elemente gespeichert werden, False wenn Elemente geladen werden
      selectOnlyFiles - True wenn nur Dokumente, Falls wenn nur Ordner selektiert werden
      selectionPath - Selektionspfad
      Returns:
      File[]
      Since:
      8.04.000

    • activateRibbonTab

      public boolean activateRibbonTab​(String tabName) throws IllegalArgumentException
      Aktiviert den angegebenen Ribbon-Tab und meldet zurück, ob der Vorgang erfolgreich war.
      Parameters:
      tabName - Bezeichnung des Ribbon-Tabs
      Returns:
      Ribbon-Tab wurde aktiviert
      Throws:
      IllegalArgumentException - Wenn keine bezeichnung angegeben wurde.
      Since:
      9.01.000

    • startBackgroundProcess

      public BackgroundJob startBackgroundProcess​(String jobTypeName, String backgroundFunction)
      Erzeugt einen neuen Hintergrundprozess im Client, welcher die angegebene Funktion ausführt. Der Prozess wird sofort gestartet und in die Übersicht der Hintergrundprozesse des Java Client eingetragen. Für serverseitige Hintergrundprozesse siehe listServerProcess.
      Parameters:
      jobTypeName - Typ unter dem der Job in der Prozessübersicht des Java Clients angezeigt wird
      backgroundFunction - Scripting-Funktion, welche in einem Hintergrundprozess aufgerufen werden soll
      Returns:
      Hintergrund Thread
      Since:
      9.02.000

    • listServerProcess

      public void listServerProcess​(String jobTypeName, String jobGuid, String message)
      Zeigt einen gestarteten Serverprozess in der Prozessliste des Java Clients.
      Parameters:
      jobTypeName - Typ unter dem der Job in der Prozessübersicht des Java Clients angezeigt wird
      jobGuid - GUID des Serverprozesses
      message - Nachricht, welche für den Status des Prozesses angezeigt wird. Als Platzhalter sind %1 für CountProcessed und %2 für CountEstimatedMax des JobState vorgsehen.
      Since:
      9.02.000