Package de.elo.client.scripting.interfaces

Klasse 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

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    WorkspaceAdapter(Workspace workspace)
    Interner Konstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    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()
    Veraltet. 
    IndexPreviewAdapter
    getIndexPreview()
    Veraltet.
    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()
    Veraltet.
    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)
    Prüft ob die Funktion mit der angegebenen Funktionsnummer im derzeitigen Zustand des Clients (aktiver Funktionsbereich, aktuelle Selektion...) verfügbar ist.
    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
    isMainWorkspace()
    Meldet zurück, ob der übergebene Workspace dem ersten Workspace entspricht.
    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)
    Ermittelt die Maskennummer zu dem angegebenen Maskennamen.
    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)
    Veraltet.
    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".
    int
    showSelectDialog(String title, String message, int rootId, boolean documentsSelectable, boolean folderSelectable, boolean showFavorites, boolean showLastUsed)
    Zeigt einen Dialog zur Auswahl eines Ordners oder Dokuments im Archiv an.
    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)
    Veraltet.
    Mit dem neuen SelectionDialog ist der mechanismus zum anzeigen von Zielvorschlägen depricated.
    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)
    Startet die Funktion mit der angegebenen ID.
    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.

    Von Klasse geerbte Methoden Object

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

  • Konstruktordetails

    • WorkspaceAdapter

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

  • Methodendetails

    • 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.
      Parameter:
      objectId - Objekt-Id
      page - Zielseite, 1-Index basiert.
      onlyIfNew - Nur eintragen, wenn es noch keinen Eintrag gibt.
      Seit:
      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...)
      Parameter:
      tabName - Scripting-Id des Tabs
      Gibt zurück:
      True, wenn der Tab gefunden wurde.
      Seit:
      10.00.000

    • addHotKey

      public void addHotKey(String keyName, String eventName)
      Registriert eine Skriptfunktion zum Aufruf über einen HotKey.
      Parameter:
      keyName - Name der Taste im Java KeyStroke Format
      eventName - Name der Callback Funktion
      Seit:
      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.
      Gibt zurück:
      Ausgewähltes Objekt oder null
      Löst aus:
      RemoteException - Wenn die Kacheln nicht gelesen werden können.
      Seit:
      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.
      Parameter:
      sourceId - Zu kopierende Kachel
      Gibt zurück:
      neue Objekt-Id
      Löst aus:
      Exception - Wenn die Kachel nicht kopiert werden kann.
      Seit:
      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.
      Parameter:
      objid - ELO Objekt zu dem der Reporteintrag geschrieben werden soll
      actionNo - Aktionsnummer, Anwenderdefiniert, 3000...3999
      extra1 - Datenbankfeld extra1
      extra2 - Datenbankfeld extra2
      message - Kommentarfeld
      Löst aus:
      Exception - Wenn der Reporteintrag nicht angelegt werden kann.
      Seit:
      9.02.000

    • toFront

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

    • hasModalDialogOpened

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

    • getLastInsertedDocument

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

    • getUserNodeId

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

    • getUserPersonalNodeId

      public int getUserPersonalNodeId()
      Liefert die ELO ObjectId des persönlichen Anwenderordners zurück.
      Gibt zurück:
      objid
      Seit:
      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.
      Parameter:
      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
      Gibt zurück:
      Import Ticket für die Abfrage des JobStates
      Löst aus:
      RemoteException - Wenn der Serverprozess nicht gestartet werden kann.
      IllegalArgumentException - Bei fehlerhaften Parametern.
      Seit:
      9.01.000

    • gotoId

      public boolean gotoId(int objId)
      Springt im Archiv an das Element mit der angegebenen ObjektID.
      Parameter:
      objId - Objekt Id des Archivelements
      Gibt zurück:
      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.
      Parameter:
      flowId - Workflow-Id
      nodeId - Knoten-Id
      Gibt zurück:
      True, wenn der Workflow gefunden und angesprungen wurde
      Seit:
      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.
      Parameter:
      guid - GUID oder GUID-Liste
      Gibt zurück:
      True wenn die objId gefunden wurde, sonst False
      Seit:
      9.02.000

    • getActiveView

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

    • showView

      public void showView(String viewName)
      Aktiviert eine Kachel anhand des Namens
      Parameter:
      viewName - Name der Kachel
      Seit:
      11.00.000

    • showTasksView

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

    • showArchiveView

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

    • showCheckoutView

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

    • showClipboardView

      public void showClipboardView() throws NavigationViewNotFoundException
      Zeigt den Funktionsbereicht "Klemmbrett".
      Löst aus:
      NavigationViewNotFoundException - Wenn kein Klemmbrett gefunden wurde.

    • showIntrayView

      public void showIntrayView() throws NavigationViewNotFoundException
      Zeigt den Funktionsbereicht "Postbox".
      Löst aus:
      NavigationViewNotFoundException - Wenn keine Postbox gefunden wurde.

    • showSearchView

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

    • showMyEloView

      public void showMyEloView() throws NavigationViewNotFoundException
      Zeigt den Funktionsbereich "Mein ELO".
      Löst aus:
      NavigationViewNotFoundException - Wenn "Mein ELO" nicht gefunden wurde.
      Seit:
      9.02.001

    • startFunction

      public void startFunction(int functionID)
      Startet die Funktion mit der angegebenen ID.
      Parameter:
      functionID - Funktionsnummer der zu startenden Client-Funktion

    • startFunction

      public void startFunction(String functionName) throws Exception
      Startet die Funktion mit dem angegebenen Namen.
      Parameter:
      functionName - Funktionsname der zu startenden Client-Funktion
      Löst aus:
      Exception - Falls keine Funktion mit diesem Namen vorhanden ist
      Seit:
      7.00.006

    • isFunctionEnabled

      public boolean isFunctionEnabled(int functionID)
      Prüft ob die Funktion mit der angegebenen Funktionsnummer im derzeitigen Zustand des Clients (aktiver Funktionsbereich, aktuelle Selektion...) verfügbar ist.
      Parameter:
      functionID - Id/Nummer der zu prüfenden Client-Funktion
      Gibt zurück:
      True wenn die Funktion verfügbar ist, sonst False
      Seit:
      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.
      Parameter:
      functionName - Name der zu startenden Client-Funktion
      Gibt zurück:
      True wenn die Funktion verfügbar ist, sonst False
      Seit:
      7.00.008

    • updateSordLists

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

    • getDocMask

      public DocMask getDocMask(String maskName) throws Exception
      Liefert das Indexserver Objekt DocMask zu einem Maskennamen zurück.
      Parameter:
      maskName - Maskenname
      Gibt zurück:
      Indexserver Objekt DocMask
      Löst aus:
      Exception - Wenn die Maske nicht vom Server gelesen werden kann.
      Seit:
      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.
      Seit:
      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".
      Parameter:
      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".
      Parameter:
      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.
      Parameter:
      title - Dialogtitel (wird im Fensterrand angezeigt)
      text - Beschreibungstext des Dialogs
      Gibt zurück:
      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
      Parameter:
      title - Fenstertitel
      text - Hinweistext, mehrzeiliger Fließtext erlaubt.
      defaultValue - Vorgabewert für das Eingabefeld
      Gibt zurück:
      Eingabetext oder null
      Seit:
      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
      Parameter:
      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
      Gibt zurück:
      Eingabetext oder null
      Seit:
      8.01.000

    • getWorkspace

      @Deprecated public Workspace getWorkspace()
      Veraltet.
      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.
      Gibt zurück:
      Workspace

    • getUserName

      public String getUserName()
      Liefert den Namen des aktuell am Client angemeldeten Benutzers.
      Gibt zurück:
      String Anwendername
      Seit:
      6.00.088

    • getUserId

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

    • getDirectories

      public DirectoriesAdapter getDirectories()
      Liefert ein Objekt für den Zugriff auf die lokalen Client Verzeichnisse.
      Gibt zurück:
      DirectoriesAdapter Adapter für die lokalen Verzeichnisse
      Seit:
      8.00.000

    • getUserRights

      public UserRightsAdapter getUserRights()
      Liefert ein Objekt für den Zugriff auf die Anwenderrechte.
      Gibt zurück:
      UserRightsAdapter Adapter für die Anwenderrechte
      Seit:
      8.00.000

    • getUserGroups

      public int[] getUserGroups()
      Liefert eine Liste aller Gruppen des aktuellen Anwenders zurück
      Gibt zurück:
      Liste der User-IDs aller Gruppen
      Seit:
      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.

      Gibt zurück:
      Liste der Namen aller Gruppen
      Seit:
      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.
      Parameter:
      idOrName - Id oder Name der Gruppe
      Gibt zurück:
      True, wenn der Anwender ein Mitglied der Gruppe ist.
      Seit:
      11.00.000

    • isMainWorkspace

      public boolean isMainWorkspace()
      Meldet zurück, ob der übergebene Workspace dem ersten Workspace entspricht.
      Gibt zurück:
      boolean true, wenn es sich um den Hauptworkspace handelt.
      Seit:
      12.06.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.
      Parameter:
      counterName - Name des Counters
      defaultValue - Defaultwert falls der Counter neu angelegt werden muss
      Gibt zurück:
      int Inkrementierter Wert, -1 wenn der Counter nicht gelesen oder erstellt werden konnte.

    • lookupMaskId

      public int lookupMaskId(String maskName)
      Ermittelt die Maskennummer zu dem angegebenen Maskennamen.
      Parameter:
      maskName - gesuchte Maske
      Gibt zurück:
      Nummer der gesuchten Maske
      Seit:
      6.00.100

    • sendHttpRequest

      public String sendHttpRequest(String url) throws IOException
      Sendet eine HTTP Anfrage und liefert die Response.
      Parameter:
      url - Adresse für die HTTP-Anfrage
      Gibt zurück:
      String HTTP Response
      Löst aus:
      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.
      Parameter:
      title - Dialogtitel (wird im Fensterrand angezeigt)
      columns - Anzahl der Spalten im Tabellenraster
      rows - Anzahl der Zeilen im Tabellenraster
      Gibt zurück:
      GridDialog Der erzeugte GridDialog
      Seit:
      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.

      Parameter:
      title - Dialogtitel (wird im Fensterrand angezeigt)
      Gibt zurück:
      Der erzeugte AppDialog
      Seit:
      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.
      Parameter:
      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
      Gibt zurück:
      UserName[] Liste mit den ausgewählten Anwender/Gruppen oder null wenn der Dialog abgebrochen wurde
      Löst aus:
      Exception - Exception Bei fehlerhaften Parametern.
      Seit:
      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.
      Parameter:
      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
      Gibt zurück:
      UserName[] Liste mit den ausgewählten Anwender/Gruppen oder null wenn der Dialog abgebrochen wurde
      Löst aus:
      Exception - Exception Bei fehlerhaften Parametern.
      Seit:
      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.
      Parameter:
      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
      Gibt zurück:
      UserName[] Liste mit den ausgewählten Anwender/Gruppen oder null wenn der Dialog abgebrochen wurde
      Löst aus:
      Exception - Exception Bei fehlerhaften Parametern.
      Seit:
      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.
      Parameter:
      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
      Gibt zurück:
      UserName[] Liste mit den ausgewählten Anwender/Gruppen oder null wenn der Dialog abgebrochen wurde
      Löst aus:
      Exception - Bei fehlerhaften Parametern.
      Seit:
      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.
      Parameter:
      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
      Gibt zurück:
      UserName[] Liste mit den ausgewählten Anwender/Gruppen oder null wenn der Dialog abgebrochen wurde
      Löst aus:
      Exception - Bei fehlerhaften Parametern.
      Seit:
      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.
      Parameter:
      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
      Gibt zurück:
      UserName[] Liste mit den ausgewählten Anwender/Gruppen oder null wenn der Dialog abgebrochen wurde
      Löst aus:
      Exception - Bei fehlerhaften Parametern.
      Seit:
      12.00.000

    • showPermissionsDialog

      public AclItem[] showPermissionsDialog(String dialogTitle, AclItem[] currentPermissions)
      Zeigt einen Dialog zur Auswahl/Einstellung von Berechtigungen.
      Parameter:
      dialogTitle - Titel des Dialogs
      currentPermissions - Aktuell gesetzte Berechtigungen / Vorauswahl der Berechtigungen
      Gibt zurück:
      AclItem[] Liste mit den ausgewählten Berechtigungen
      Seit:
      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.
      Parameter:
      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.
      Gibt zurück:
      Nummer der Auswahl (Zählung beginnt bei 1) oder -1 bei "Abbrechen" oder -2 bei ungültigen Parameterangaben
      Löst aus:
      Exception - Wenn Icons nicht geladen werden können.
      Seit:
      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.
      Gibt zurück:
      String Sprachcode laut ISO 639 in Kleinbuchstaben
      Seit:
      7.00.004

    • getClientVersion

      public String getClientVersion()
      Liefert die Versionsnummer dieses Clients.
      Gibt zurück:
      Versionsnummer, z.B. "8.04.000"
      Seit:
      8.04.000

    • getConnectionNumber

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

    • sendBroadcast

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

    • sendMail

      public void sendMail(String subject, String receiver, String content, String[] attachNames) throws Exception
      Versendet eine Mail
      Parameter:
      subject - Betreff
      receiver - Empfängeradresse
      content - (HTML) Mailkörper
      attachNames - Liste der Attachment-Dateipfade
      Löst aus:
      Exception - Wenn beim Zugriff auf das E-Mail Programm Fehler auftreten.
      Seit:
      9.01.003

    • setStatusMessage

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

    • setSyncCallback

      public void setSyncCallback(String callbackName)
      Setzt den Namen der Callback Funktion in der MobileSync Behandlung.
      Parameter:
      callbackName -
      Seit:
      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.
      Parameter:
      messageText - Der anzuzeigende Text.
      Seit:
      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.
      Parameter:
      type - Art des Feedbacks.
      messageText - Der anzuzeigende Text.
      Seit:
      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.
      Parameter:
      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
      Gibt zurück:
      int ObjektID des selektierten Eintrags oder -1 falls der Dialog abgebrochen wurde
      Seit:
      7.00.006

    • showSelectDialog

      public int showSelectDialog(String title, String message, int rootId, boolean documentsSelectable, boolean folderSelectable, boolean showFavorites, boolean showLastUsed)
      Zeigt einen Dialog zur Auswahl eines Ordners oder Dokuments im Archiv an.
      Parameter:
      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" angezeigt werden soll
      showLastUsed - True, wenn die Liste mit "Zuletzt Verwendet" angezeigt werden soll
      Gibt zurück:
      int ObjektID des selektierten Eintrags oder -1 falls der Dialog abgebrochen wurde
      Seit:
      23.06.000

    • 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.
      Parameter:
      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 (bei -1 wird die zuletzt im SelectionDialog verwendete Selection angezeigt)
      Gibt zurück:
      ObjektID des selektierten Eintrags oder -1 falls der Dialog abgebrochen wurde
      Seit:
      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)
      Veraltet.
      Mit dem neuen SelectionDialog ist der mechanismus zum anzeigen von Zielvorschlägen depricated. Verwenden Sie bitte ).
      Zeigt einen Dialog für die Auswahl eines Archiveintrags an.
      Parameter:
      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
      Gibt zurück:
      ObjektID des selektierten Eintrags oder -1 falls der Dialog abgebrochen wurde
      Seit:
      10.01.000

    • getHintManager

      @Deprecated public HintManager getHintManager()
      Veraltet.
      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.
      Gibt zurück:
      Hintmanager aus der letzten Verwendung von showTreeSelectDialog(String, String, int, boolean, boolean, boolean, boolean, int, File)
      Seit:
      10.01.000

    • sendELOasRequest

      @Deprecated public void sendELOasRequest(String serverName, int port, String serviceName, boolean withTicket, String rulesetName, String param1, String param2, String param3) throws Exception
      Veraltet.
      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.
      Parameter:
      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.
      Löst aus:
      Exception - Wenn der Zugriff auf den ELOas nicht ausgeführt werden konnte.
      Seit:
      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.
      Parameter:
      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.
      Gibt zurück:
      HTTP Statuscode
      Löst aus:
      Exception - Wenn der Zugriff auf den ELOas nicht ausgeführt werden konnte.
      Seit:
      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.
      Parameter:
      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.
      Gibt zurück:
      HTTP Statuscode
      Löst aus:
      Exception - Wenn der Zugriff auf den ELOas nicht ausgeführt werden konnte.
      Seit:
      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.
      Parameter:
      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.
      Gibt zurück:
      ELOas Rückgabewert
      Löst aus:
      Exception - Wenn der Zugriff auf den ELOas nicht ausgeführt werden konnte.
      Seit:
      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.
      Parameter:
      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.
      Gibt zurück:
      ELOas Rückgabewert
      Löst aus:
      Exception - Wenn der Zugriff auf den ELOas nicht ausgeführt werden konnte.
      Seit:
      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}
      Parameter:
      url - URL
      Gibt zurück:
      Response Content
      Löst aus:
      IOException - Wenn der HTTP Aufruf nicht funktioniert
      Seit:
      11.01.000

    • getIndexPreview

      @Deprecated public IndexPreviewAdapter getIndexPreview()
      Veraltet.
      20.00
      Liefert ein Objekt zum Zugriff auf die Verschlagwortungsvorschau.
      Gibt zurück:
      Verschlagwortungsvorschau
      Seit:
      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.
      Parameter:
      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
      Gibt zurück:
      Neuer Funktionsbereich
      Seit:
      8.01.000

    • removeView

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

    • setScriptButtonEnabled

      public void setScriptButtonEnabled(int nr, boolean enabled)
      Setzt die Aktivierung eines ScriptButtons.
      Parameter:
      nr - Nummer des ScriptButtons (0 bis 999)
      enabled - True wenn der ScriptButton aktiv sein soll, False für inaktiv.
      Seit:
      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.
      Parameter:
      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
      Seit:
      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.
      Parameter:
      nr - Nummer des ScriptButtons (0 bis 999)
      functionName - Funktionsname der Basisfunktion an welche die Aktivierung gekoppelt werden soll
      Löst aus:
      Exception - Falls keine Funktion mit diesem Namen vorhanden ist
      Seit:
      9.00.000

    • setWaitCursor

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

    • setCookie

      public void setCookie(String key, String value)
      Setzt ein Cookie im OleAutomation Interface.
      Parameter:
      key -
      value -
      Seit:
      12.00.000

    • getCookie

      public String getCookie(String key)
      Liefert den Wert eines Cookies aus dem Ole Automation Interface zurück.
      Parameter:
      key -
      Gibt zurück:
      Seit:
      12.00.000

    • setNormalCursor

      public void setNormalCursor()
      Setzt den normalen Mauszeiger.
      Seit:
      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.
      Parameter:
      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
      Gibt zurück:
      File[]
      Seit:
      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.
      Parameter:
      tabName - Bezeichnung des Ribbon-Tabs
      Gibt zurück:
      Ribbon-Tab wurde aktiviert
      Löst aus:
      IllegalArgumentException - Wenn keine bezeichnung angegeben wurde.
      Seit:
      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.
      Parameter:
      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
      Gibt zurück:
      Hintergrund Thread
      Seit:
      9.02.000

    • listServerProcess

      public void listServerProcess(String jobTypeName, String jobGuid, String message)
      Zeigt einen gestarteten Serverprozess in der Prozessliste des Java Clients.
      Parameter:
      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.
      Seit:
      9.02.000