de.elo.client.scripting.interfaces
Class TasksAdapter

java.lang.Object
  de.elo.client.scripting.interfaces.ViewAdapter
      de.elo.client.scripting.interfaces.TasksAdapter

public class TasksAdapter
extends ViewAdapter

Überschrift: TasksAdapter

Beschreibung: Kapselt den Tasks-Funktionsbereich (Aufgaben) gegenüber dem Script. Im Scripting verfügbar als "tasks".

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

Constructor Summary

TasksAdapter(de.elo.client.maindialog.Workspace workspace)
Normaler Konstruktor.

Method Summary

void	clearSelection() Löscht die aktuelle Selektion in der Aufgabentabelle.
int[]	createReminder(java.lang.String titel, java.lang.String memo, java.lang.String datum, java.lang.String[] ids, int prio, de.elo.ix.client.Document document) Deprecated. Ersetzt durch createReminder( String titel, String memo, String datum, String[] ids, int prio, int objectId )
int[]	createReminder(java.lang.String titel, java.lang.String memo, java.lang.String datum, java.lang.String[] ids, int prio, int objectId) Erzeugt eine neue Wiedervorlage mit den angegebenen Parametern.
java.util.Enumeration<TaskElement>	getAllSelected() Liefert eine Aufzählung mit den selektierten Aufgaben zurück.
de.elo.ix.client.Document	getDocument(int objId) Liefert das durch objId identifizierte Dokument zurück.
static TaskElement	getElement(de.elo.client.maindialog.Workspace workspace, de.elo.ix.client.UserTask task) Liefert das gesuchte Element zurück - entweder eine Wiedervorlage oder ein Workflow.
java.util.Enumeration<TaskElement>	getElements() Liefert eine Aufzählung mit den vorhandenen Aufgaben zurück.
TaskElement	getFirstSelected() Liefert die erste selektierte Aufgabe in der Aufgabentabelle.
java.lang.String	getName() Gibt den Namen der Ansicht zurück.
ReminderElement	getReminder(int reminderId) Liefert die Wiedervorlage für die angegebene reminderId (falls gefunden), ansonsten null zurück.
ReminderElement	getReminder(java.lang.String reminderName) Liefert die Wiedervorlage mit dem angegebenen Namen (falls gefunden), ansonsten null, zurück.
TaskElement	getRow(int rowNo) Liefert die Aufgabe(TaskElement) aus der angegebenen Tabellenzeile.
java.util.Enumeration<TaskElement>	getSelected() Deprecated.
int	getSelectionCount() Liefert die Anzahl an selektieren Aufgaben in der Aufgabentabelle.
int	getTaskCount() Diese Funktion liefert die Anzahl der vorhandenen Aufgaben zurück.
WorkflowElement	getWorkflow(int workflowId) Liefert den Workflow für die angegebene workflowId (falls gefunden), ansonsten null, zurück.
WorkflowElement	getWorkflow(java.lang.String flowName) Liefert den Workflow mit dem angegebenen Namen (falls gefunden), ansonsten null, zurück.
boolean	hasSelection() Meldet zurück, ob in der Aufgabenliste mindestens eine Aufgabe/Archivelement selektiert ist.
void	refresh() Aktualisiert den Inhalt dieser Ansicht.
void	select(TaskElement taskElement) Selektiert die angegebene Aufgabe in der Aufgabentabelle.
void	selectReminder(int reminderId) Selektiert die angegebene Wiedervorlage in der Aufgabenliste.
void	selectRow(int rowNo) Selektiert die angegebene Zeile in der Aufgabentabelle.
void	selectRows(int[] rowNumbers) Selektiert die angegebenen Zeilen in die Aufgabentabelle.
void	selectWorkflow(int workflowId) Selektiert den angegebenen Workflow in der Aufgabentabelle.
int	startApprovalWorkflow(java.lang.String name, java.lang.String objId, java.lang.String[] userids, java.lang.String startNode, java.lang.String cancelUserId, java.lang.String cancelMessage, java.lang.String finishedUserId, java.lang.String finishedMessage) Startet einen neuen Freigabe-AdhocWorkflow.
int	startNoticeWorkflow(java.lang.String name, java.lang.String objId, java.lang.String[] userids, java.lang.String startNode, java.lang.String cancelUserId, java.lang.String cancelMessage, java.lang.String finishedUserId, java.lang.String finishedMessage) Startet einen neuen Kenntnisnahme-AdhocWorkflow.
int	startWorkflow(java.lang.String objId, java.lang.String name, int workflowTemplateId) Startet einen Workflow mit dem angegebenen Archiveintrag.

Methods inherited from class de.elo.client.scripting.interfaces.ViewAdapter

show

Methods inherited from class java.lang.Object

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

Constructor Detail

TasksAdapter

public TasksAdapter(de.elo.client.maindialog.Workspace workspace)

Normaler Konstruktor.

Parameters:

workspace - Aktueller Arbeitsbereich

Method Detail

selectRow

public void selectRow(int rowNo)

Selektiert die angegebene Zeile in der Aufgabentabelle.

Parameters:

rowNo - Tabellenzeile

selectRows

public void selectRows(int[] rowNumbers)

Selektiert die angegebenen Zeilen in die Aufgabentabelle.

Parameters:

rowNumbers - Liste mit zu selektierenden Tabellenzeilen, angefangen wird bei 0

Since:

7.00.004

select

public void select(TaskElement taskElement)
            throws de.elo.client.navigation.NavigationViewNotFoundException

Selektiert die angegebene Aufgabe in der Aufgabentabelle.

Parameters:

taskElement - Aufgabe

Throws:

de.elo.client.navigation.NavigationViewNotFoundException

hasSelection

public boolean hasSelection()

Meldet zurück, ob in der Aufgabenliste mindestens eine Aufgabe/Archivelement selektiert ist.

Specified by:

hasSelection in class ViewAdapter

Returns:

boolean True wenn eine Selektion vorhanden ist, sonst False

getSelectionCount

public int getSelectionCount()

Liefert die Anzahl an selektieren Aufgaben in der Aufgabentabelle.

Specified by:

getSelectionCount in class ViewAdapter

Returns:

int

Since:

7.00.004

getSelected

public java.util.Enumeration<TaskElement> getSelected()
                                               throws java.lang.Exception

Deprecated.

Liefert eine Aufzählung mit den aktuell selektierten Aufgaben zurück.

Returns:

Enumeration

Throws:

java.lang.Exception

getAllSelected

public java.util.Enumeration<TaskElement> getAllSelected()
                                                  throws java.lang.Exception

Liefert eine Aufzählung mit den selektierten Aufgaben zurück.

Specified by:

getAllSelected in class ViewAdapter

Returns:

Aufzählung mit selektierten Aufgaben

Throws:

java.lang.Exception

Since:

7.00.004

getFirstSelected

public TaskElement getFirstSelected()
                             throws java.lang.Exception

Liefert die erste selektierte Aufgabe in der Aufgabentabelle.

Specified by:

getFirstSelected in class ViewAdapter

Returns:

Selektierte Aufgaben oder null, wenn keine Selektion vorhanden ist

Throws:

java.lang.Exception

Since:

7.00.004

getTaskCount

public int getTaskCount()

Diese Funktion liefert die Anzahl der vorhandenen Aufgaben zurück.

Returns:

int

getRow

public TaskElement getRow(int rowNo)
                   throws de.elo.client.navigation.NavigationViewNotFoundException

Liefert die Aufgabe(TaskElement) aus der angegebenen Tabellenzeile.

Parameters:

rowNo - Tabellenzeile

Returns:

TaskElement

Throws:

de.elo.client.navigation.NavigationViewNotFoundException

getElement

public static TaskElement getElement(de.elo.client.maindialog.Workspace workspace,
                                     de.elo.ix.client.UserTask task)
                              throws de.elo.client.navigation.NavigationViewNotFoundException

Liefert das gesuchte Element zurück - entweder eine Wiedervorlage oder ein Workflow.

Parameters:

workspace - Aktueller Arbeitsbereich

task - Aufgaben-Objekt vom IndexServer

Returns:

TaskElement Aufgabe-Wiedervorlage oder Workflow

Throws:

de.elo.client.navigation.NavigationViewNotFoundException

getElements

public java.util.Enumeration<TaskElement> getElements()
                                               throws de.elo.client.navigation.NavigationViewNotFoundException

Liefert eine Aufzählung mit den vorhandenen Aufgaben zurück.

Returns:

Enumeration

Throws:

de.elo.client.navigation.NavigationViewNotFoundException

getReminder

public ReminderElement getReminder(int reminderId)
                            throws de.elo.client.navigation.NavigationViewNotFoundException

Liefert die Wiedervorlage für die angegebene reminderId (falls gefunden), ansonsten null zurück.

Parameters:

reminderId - Id der gesuchten Wiedervorlage

Returns:

ReminderElement Wiedervorlage

Throws:

de.elo.client.navigation.NavigationViewNotFoundException

getReminder

public ReminderElement getReminder(java.lang.String reminderName)
                            throws de.elo.client.navigation.NavigationViewNotFoundException

Liefert die Wiedervorlage mit dem angegebenen Namen (falls gefunden), ansonsten null, zurück.

Parameters:

reminderName - Bezeichnung der Wiedervorlage

Returns:

ReminderElement Erste gefundene Wiedervorlage oder null

Throws:

de.elo.client.navigation.NavigationViewNotFoundException

Since:

7.00.004

selectReminder

public void selectReminder(int reminderId)

Selektiert die angegebene Wiedervorlage in der Aufgabenliste.

Parameters:

reminderId - Id der zu selektierenden Wiedervorlage

getWorkflow

public WorkflowElement getWorkflow(int workflowId)
                            throws de.elo.client.navigation.NavigationViewNotFoundException

Liefert den Workflow für die angegebene workflowId (falls gefunden), ansonsten null, zurück.

Parameters:

workflowId - Id des gesuchten Workflows

Returns:

WorkflowElement Der erste gefundene Workflow

Throws:

de.elo.client.navigation.NavigationViewNotFoundException

getWorkflow

public WorkflowElement getWorkflow(java.lang.String flowName)
                            throws de.elo.client.navigation.NavigationViewNotFoundException

Liefert den Workflow mit dem angegebenen Namen (falls gefunden), ansonsten null, zurück.

Parameters:

flowName - Workflowname

Returns:

WorkflowElement Der erste Workflow mit dem angegebenen Namen oder null

Throws:

de.elo.client.navigation.NavigationViewNotFoundException

Since:

7.00.004

selectWorkflow

public void selectWorkflow(int workflowId)

Selektiert den angegebenen Workflow in der Aufgabentabelle.

Parameters:

workflowId - Id des zu selektierenden Workflows

createReminder

public int[] createReminder(java.lang.String titel,
                            java.lang.String memo,
                            java.lang.String datum,
                            java.lang.String[] ids,
                            int prio,
                            de.elo.ix.client.Document document)
                     throws java.rmi.RemoteException

Deprecated. Ersetzt durch createReminder( String titel, String memo, String datum, String[] ids, int prio, int objectId )

Erzeugt eine neue Wiedervorlage mit den angegebenen Parametern. Die Wiedervorlage erscheint in der Aufgabenliste.

Parameters:

titel - Bezeichnung der Wiedervorlage

memo - Beschreibung der Wiedervorlage

datum - Datum der Wiedervorlage

ids - Liste mit Anwendern, an die die Wiedervorlage geschickt wird

prio - Priorität der Wiedervorlage

document - Das Dokument, das für die Wiedervorlage verwendet wird

Returns:

Die Id der erzeugten Wiedervorlage

Throws:

java.rmi.RemoteException

createReminder

public int[] createReminder(java.lang.String titel,
                            java.lang.String memo,
                            java.lang.String datum,
                            java.lang.String[] ids,
                            int prio,
                            int objectId)
                     throws java.rmi.RemoteException

Erzeugt eine neue Wiedervorlage mit den angegebenen Parametern. Die Wiedervorlage erscheint in der Aufgabenliste.

Parameters:

titel - Bezeichnung der Wiedervorlage

memo - Beschreibung der Wiedervorlage

datum - Datum der Wiedervorlage

ids - Liste mit Anwendern, an die die Wiedervorlage geschickt wird

prio - Priorität der Wiedervorlage
0: Hoch / A
1: Mittel / B
2: Niedrig / C

objectId - Archiveintrag für den die Wiedervorlage angelegt werden soll

Returns:

Die Id der erzeugten Wiedervorlage

Throws:

java.rmi.RemoteException

Since:

8.01.000

getDocument

public de.elo.ix.client.Document getDocument(int objId)
                                      throws java.rmi.RemoteException

Liefert das durch objId identifizierte Dokument zurück.

Parameters:

objId - ObjektId des Dokumentes

Returns:

Document

Throws:

java.rmi.RemoteException

startApprovalWorkflow

public int startApprovalWorkflow(java.lang.String name,
                                 java.lang.String objId,
                                 java.lang.String[] userids,
                                 java.lang.String startNode,
                                 java.lang.String cancelUserId,
                                 java.lang.String cancelMessage,
                                 java.lang.String finishedUserId,
                                 java.lang.String finishedMessage)
                          throws java.rmi.RemoteException

Startet einen neuen Freigabe-AdhocWorkflow. Das Workflow wird in der Aufgabenliste der angegebenen Anwender erscheinen.

Parameters:

name - Workflowname

objId - ObjektID des Dokuments oder Ordners zu dem der Workflow gestartet werden soll.

userids - Liste mit Anwendern, die das Workflow bekommen

startNode - Bezeichnung des Startknotens des Workflows

cancelUserId - Anwender, der eine Unterbrechungsnachricht bekommt

cancelMessage - Unterbrechungsnachricht, die an dem angegebenen Anwender gesendet wird

finishedUserId - Anwender, der eine Bestätigungsnachricht bekommt

finishedMessage - Nachricht, die die erfolgreiche Ausführung des Workflows bestätigt

Returns:

int Die Id des gestarteten Workflows

Throws:

java.rmi.RemoteException

startNoticeWorkflow

public int startNoticeWorkflow(java.lang.String name,
                               java.lang.String objId,
                               java.lang.String[] userids,
                               java.lang.String startNode,
                               java.lang.String cancelUserId,
                               java.lang.String cancelMessage,
                               java.lang.String finishedUserId,
                               java.lang.String finishedMessage)
                        throws java.rmi.RemoteException

Startet einen neuen Kenntnisnahme-AdhocWorkflow. Das Workflow wird in den Aufgabenliste der angegebenen Anwender erscheinen.

Parameters:

name - Workflowname

objId - ObjektID des Dokuments oder Ordners zu dem der Workflow gestartet werden soll.

userids - Liste mit Anwendern, die das Workflow bekommen werden

startNode - Bezeichnung des Startknotens des Workflows

cancelUserId - Anwender, der die Unterbrechungsnachricht bekommt

cancelMessage - Unterbrechungsnachricht

finishedUserId - Anwender, der die Bestätigungsnachricht bekommt

finishedMessage - Nachricht, die die erfolgreiche Ausführung des Workflows bestätigt

Returns:

Die Id des gestarteten Workflows

Throws:

java.rmi.RemoteException

startWorkflow

public int startWorkflow(java.lang.String objId,
                         java.lang.String name,
                         int workflowTemplateId)

Startet einen Workflow mit dem angegebenen Archiveintrag. Es wird danach versucht, den soeben gestarteten Workflow in der Aufgabenliste zu selektieren. Damit dies möglich ist, muss in der Workflow-Vorlage als erster Personenknoten der aktuelle Anwender vorgesehen sein. Diese Methode ist vor allem für das Starten von Formular-Workflows gedacht.

Parameters:

objId - ObjektID des Dokuments oder Ordners zu dem der Workflow gestartet werden soll.

name - Name der Workflows

workflowTemplateId - Id der Workflow-Vorlage, mit der das Workflow gestartet wird

Returns:

Die Id des gestarteten Workflows oder -1 bei einem Fehler

Since:

8.00.006

getName

public java.lang.String getName()

Description copied from class: ViewAdapter

Gibt den Namen der Ansicht zurück. Bei Archivansichten ist das der Name des Root-Elements, bei anderen Ansichten der Name der Ansicht "Archive: (Rootname)", "Checkout", "Clipboard", "Search", "Tasks", "Intray".

Specified by:

getName in class ViewAdapter

Returns:

String

refresh

public void refresh()

Description copied from class: ViewAdapter

Aktualisiert den Inhalt dieser Ansicht.

Specified by:

refresh in class ViewAdapter

clearSelection

public void clearSelection()

Löscht die aktuelle Selektion in der Aufgabentabelle.

Since:

8.00.000