|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.elo.client.scripting.interfaces.WorkspaceAdapter
public class WorkspaceAdapter
Überschrift: WorkspaceAdapter
Beschreibung: Kapselt den Workspace gegenüber dem Script. Im Scripting verfügbar als "workspace".
Copyright: Copyright (c) ELO Digital Office GmbH 2007, 2008-2011
Constructor Summary | |
---|---|
WorkspaceAdapter(de.elo.client.maindialog.Workspace workspace)
Normaler Konstruktor. |
Method Summary | |
---|---|
ExtraView |
addView(java.lang.String viewName,
boolean closeable,
javax.swing.JComponent navigationComponent,
javax.swing.JComponent topComponent)
Deprecated. UNDER CONSTRUCTION, do not use this function, it may change. |
GridDialog |
createGridDialog(java.lang.String title,
int columns,
int rows)
Erzeugt einen Dialog mit einem Tabellenlayout. |
ViewAdapter |
getActiveView()
Liefert einen Adapter für die aktuelle Ansicht zurück. |
DirectoriesAdapter |
getDirectories()
Liefert ein Objekt für den Zugriff auf die lokalen Client Verzeichnisse. |
java.lang.String |
getELOas(java.lang.String serverName,
int port,
java.lang.String serviceName,
boolean withTicket,
java.lang.String rulesetName,
java.lang.String param1,
java.lang.String param2,
java.lang.String param3)
Synchroner Aufruf eine ELOas Ruleset mit Rückgabewert. |
IndexPreviewAdapter |
getIndexPreview()
Liefert ein Objekt zum Zugriff auf die Verschlagwortungsvorschau. |
java.lang.String |
getLanguage()
Liefert die eingestellte Sprache des Clients, z.B. |
int |
getUserId()
Liefert die Id des aktuell angemeldeten Anwenders zurück oder -1 wenn kein Anwender angemeldet ist. |
java.lang.String |
getUserName()
Liefert den Namen des aktuell am Client angemeldeten Benutzers. |
UserRightsAdapter |
getUserRights()
Liefert ein Objekt für den Zugriff auf die Anwenderrechte. |
de.elo.client.maindialog.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. |
boolean |
gotoId(int objId)
Springt im Archiv an das Element mit der angegebenen ObjektID. |
int |
incCounter(java.lang.String counterName,
int defaultValue)
Zählt den angegebenen Counter um einen Wert hoch. |
boolean |
isFunctionEnabled(int functionID)
Deprecated. ersetzt durch isFunctionEnabled( String functionName ) |
boolean |
isFunctionEnabled(java.lang.String functionName)
Prüft ob die Funktion mit der angegebenen Funktionsnummer im derzeitigen Zustand des Clients (aktiver Funktionsbereich, aktuelle Selektion...) verfügbar ist. |
int |
lookupMaskId(java.lang.String maskName)
Deprecated. Ersetzt durch ArchiveAdapter.lookupMaskId( String maskName ) |
void |
removeView(java.lang.String viewName)
Deprecated. UNDER CONSTRUCTION, do not use this function, it may change. |
int |
runELOas(java.lang.String serverName,
int port,
java.lang.String serviceName,
boolean withTicket,
java.lang.String rulesetName,
java.lang.String param1,
java.lang.String param2,
java.lang.String param3)
Aufruf eine ELOas Ruleset. |
void |
sendELOasRequest(java.lang.String serverName,
int port,
java.lang.String serviceName,
boolean withTicket,
java.lang.String rulesetName,
java.lang.String param1,
java.lang.String param2,
java.lang.String param3)
Deprecated. Dieser Aufruf hat einen Fehler, der serviceName muss mit "/" beginnen, damit er funktioniert. Ersetzt durch runELOas mit korrigiertem serviceNamen. |
java.lang.String |
sendHttpRequest(java.lang.String url)
Sendet eine HTTP Anfrage und liefert die Response. |
void |
setFeedbackMessage(java.lang.String messageText)
Setzt einen Text welcher kurz im Workspace eingeblendet wird. |
void |
setNormalCursor()
Setzt den normalen Mauszeiger. |
void |
setScriptButtonEnabled(int nr,
boolean enabled)
Deprecated. UNDER CONSTRUCTION, do not use this function, it may change. |
void |
setStatusMessage(java.lang.String messageText)
Setzt den angegebenen Text in der Statuszeile des Java Client. |
void |
setWaitCursor()
Setzt den Warte-Mauszeiger. |
void |
showAlertBox(java.lang.String title,
java.lang.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". |
void |
showInfoBox(java.lang.String title,
java.lang.String text)
Zeigt einen Informationsdialog mit den angegebenen Titel und Text. |
java.lang.String |
showInputBox(java.lang.String title,
java.lang.String text,
java.lang.String defaultValue,
int minLength,
int maxLength,
boolean isPwdDialog,
int alignment)
Zeigt eine Input Box an. |
void |
showIntrayView()
Zeigt den Funktionsbereicht "Postbox". |
boolean |
showQuestionBox(java.lang.String title,
java.lang.String text)
Zeigt einen Fragedialog mit den angegebenen Titel und Text. |
void |
showSearchView()
Zeigt den Funktionsbereicht "Suche". |
java.lang.String |
showSimpleInputBox(java.lang.String title,
java.lang.String text,
java.lang.String defaultValue)
Zeigt eine Input Box an. |
void |
showTasksView()
Zeigt den Funktionsbereicht "Aufgaben". |
int |
showTreeSelectDialog(java.lang.String title,
java.lang.String message,
int rootId,
boolean documentsSelectable,
boolean folderSelectable,
boolean showFavorites)
Zeigt einen Dialog zur Auswahl eines Ordners oder Dokuments im Archiv an. |
de.elo.ix.client.UserName[] |
showUserSelectionDialog(boolean multiselect,
int min,
int max,
boolean allowUsers,
boolean allowGroups)
Zeigt einen Dialog zur Auswahl von Anwendern und/oder Gruppen. |
void |
startFunction(int functionID)
Deprecated. ersetzt durch startFunction( String functionName ) |
void |
startFunction(java.lang.String functionName)
Startet die Funktion mit dem angegebenen Namen. |
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 java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WorkspaceAdapter(de.elo.client.maindialog.Workspace workspace)
workspace
- Aktueller ArbeitsbereichMethod Detail |
---|
public boolean gotoId(int objId)
objId
- Objekt Id des Archivelements
public ViewAdapter getActiveView()
public void showTasksView() throws de.elo.client.navigation.NavigationViewNotFoundException
de.elo.client.navigation.NavigationViewNotFoundException
public void showArchiveView() throws de.elo.client.navigation.NavigationViewNotFoundException
de.elo.client.navigation.NavigationViewNotFoundException
public void showCheckoutView() throws de.elo.client.navigation.NavigationViewNotFoundException
de.elo.client.navigation.NavigationViewNotFoundException
public void showClipboardView() throws de.elo.client.navigation.NavigationViewNotFoundException
de.elo.client.navigation.NavigationViewNotFoundException
public void showIntrayView() throws de.elo.client.navigation.NavigationViewNotFoundException
de.elo.client.navigation.NavigationViewNotFoundException
public void showSearchView() throws de.elo.client.navigation.NavigationViewNotFoundException
de.elo.client.navigation.NavigationViewNotFoundException
public void startFunction(int functionID)
functionID
- Funktionsnummer der zu startenden Client-Funktionpublic void startFunction(java.lang.String functionName) throws java.lang.Exception
functionName
- Funktionsname der zu startenden Client-Funktion
java.lang.Exception
- Falls keine Funktion mit diesem Namen vorhanden istpublic boolean isFunctionEnabled(int functionID)
functionID
- Id/Nummer der zu prüfenden Client-Funktion
public boolean isFunctionEnabled(java.lang.String functionName)
functionName
- Name der zu startenden Client-Funktion
public void updateSordLists()
public void updateKeywords()
public void updateMasks()
public void updateUsers()
public void updateScripts()
public void showInfoBox(java.lang.String title, java.lang.String text)
title
- Dialogtitel (wird im Fensterrand angezeigt)text
- Beschreibungstext des Dialogspublic void showAlertBox(java.lang.String title, java.lang.String text)
title
- Dialogtitel (wird im Fensterrand angezeigt)text
- Beschreibungstext des Dialogspublic boolean showQuestionBox(java.lang.String title, java.lang.String text)
title
- Dialogtitel (wird im Fensterrand angezeigt)text
- Beschreibungstext des Dialogs
public java.lang.String showSimpleInputBox(java.lang.String title, java.lang.String text, java.lang.String defaultValue)
title
- Fenstertiteltext
- Hinweistext, mehrzeiliger Fließtext erlaubt.defaultValue
- Vorgabewert für das Eingabefeld
public java.lang.String showInputBox(java.lang.String title, java.lang.String text, java.lang.String defaultValue, int minLength, int maxLength, boolean isPwdDialog, int alignment)
title
- Fenstertiteltext
- Hinweistext, mehrzeiliger Fließtext erlaubt.defaultValue
- Vorgabewert für das EingabefeldminLength
- Minimale Eingabelänge (-1 für keine Beschränkung)maxLength
- Maximale Eingabelänge (-1 für keine Beschränkung)isPwdDialog
- alignment
- 2: Links, 4: Rechts, 0: Center
public de.elo.client.maindialog.Workspace getWorkspace()
public java.lang.String getUserName()
public int getUserId()
public DirectoriesAdapter getDirectories()
public UserRightsAdapter getUserRights()
public int incCounter(java.lang.String counterName, int defaultValue)
counterName
- Name des CountersdefaultValue
- Defaultwert falls der Counter neu angelegt werden muss
public int lookupMaskId(java.lang.String maskName)
maskName
- gesuchte Maske
public java.lang.String sendHttpRequest(java.lang.String url)
url
- Adresse für die HTTP-Anfrage
public GridDialog createGridDialog(java.lang.String title, int columns, int rows)
title
- Dialogtitel (wird im Fensterrand angezeigt)columns
- Anzahl der Spalten im Tabellenrasterrows
- Anzahl der Zeilen im Tabellenraster
public de.elo.ix.client.UserName[] showUserSelectionDialog(boolean multiselect, int min, int max, boolean allowUsers, boolean allowGroups) throws java.lang.Exception
multiselect
- Bei True ist Mehrfachauswahl erlaubt, bei False kann nur ein Anwender oder
eine Gruppe ausgewählt werdenmin
- Minimale Anzahl an Anwendern/Gruppen die selektiert sein mussmax
- Maximale Anzahl an Anwendern/Gruppen die selektiert sein darfallowUsers
- Es dürfen Anwender ausgewählt werdenallowGroups
- Es dürfen Gruppen ausgewählt werden
java.lang.Exception
public java.lang.String getLanguage()
public void setStatusMessage(java.lang.String messageText)
messageText
- Der in der Statuszeile anzuzeigende Text.public void setFeedbackMessage(java.lang.String messageText)
messageText
- Der anzuzeigende Text.public int showTreeSelectDialog(java.lang.String title, java.lang.String message, int rootId, boolean documentsSelectable, boolean folderSelectable, boolean showFavorites)
title
- Dialogtitelmessage
- Eine Nachricht, welche über dem Baum angezeigt wirdrootId
- ObjektID des Startknotens, 1 für den ArchivanfangdocumentsSelectable
- Definiert, ob Dokumente ausgewählt werden könnenfolderSelectable
- Definiert, ob Ordner ausgewählt werden könnenshowFavorites
- True, wenn die Liste mit "Favoriten" und "Zuletzt benutzt" angezeigt
werden soll
public void sendELOasRequest(java.lang.String serverName, int port, java.lang.String serviceName, boolean withTicket, java.lang.String rulesetName, java.lang.String param1, java.lang.String param2, java.lang.String param3) throws java.io.IOException
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.
java.io.IOException
public int runELOas(java.lang.String serverName, int port, java.lang.String serviceName, boolean withTicket, java.lang.String rulesetName, java.lang.String param1, java.lang.String param2, java.lang.String param3) throws java.lang.Exception
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.
java.lang.Exception
public java.lang.String getELOas(java.lang.String serverName, int port, java.lang.String serviceName, boolean withTicket, java.lang.String rulesetName, java.lang.String param1, java.lang.String param2, java.lang.String param3) throws java.lang.Exception
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.
java.lang.Exception
public IndexPreviewAdapter getIndexPreview()
public ExtraView addView(java.lang.String viewName, boolean closeable, javax.swing.JComponent navigationComponent, javax.swing.JComponent topComponent)
viewName
- closeable
- navigationComponent
- topComponent
-
public void removeView(java.lang.String viewName)
viewName
- public void setScriptButtonEnabled(int nr, boolean enabled)
nr
- Nummer des Buttons (0 bis 999)enabled
- True wenn der ScriptButton aktiv sein soll, False für inaktiv.public void setWaitCursor()
public void setNormalCursor()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |