de.elo.client.scripting.items
Class WorkflowElement

java.lang.Object
  de.elo.client.scripting.items.IndexedElement
      de.elo.client.scripting.items.TaskElement
          de.elo.client.scripting.items.WorkflowElement

public class WorkflowElement
extends TaskElement

Überschrift: WorkflowElement.

Beschreibung: Ein Workflow.

ACHTUNG: Diese Klasse leitet sich erst ab 8.01.000 von IndexedElement ab.

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

Constructor Summary

WorkflowElement(de.elo.client.maindialog.Workspace workspace, de.elo.ix.client.UserTask task)
Konstruktor für die Klasse "WorkflowElement".

Method Summary

void	confirmFlow(int[] successorIds) Leitet das Workflow an die angegebenen Nachfolger weiter.
void	confirmFlow(java.lang.String name, java.lang.String comment, int[] successorIds) Leitet das Workflow an die angegebenen Nachfolger weiter.
boolean	del() Löscht diesen Workflow.
void	delegateWorkflowNode(int userId, java.lang.String nodeName, java.lang.String nodeComment, boolean workflowRetoure) Delegiert den aktiven Workflowknoten an den übergebenen Anwender/Gruppe.
void	delegateWorkflowNode(java.lang.String userName, java.lang.String nodeName, java.lang.String nodeComment, boolean workflowRetoure) Delegiert den aktiven Workflowknoten an den übergebenen Anwender/Gruppe.
ArchiveElement	getArchiveElement() Liefert den zu der Aufgabe gehörenden Archiveintrag.
java.util.Enumeration<ArchiveElement>	getChildren() Liefert eine Aufzählung aller Einträge (als ArchiveElement-Objekte ArchiveDokument oder StructureElement), falls sich die Aufgabe auf einen Ordner bezieht.
de.elo.ix.client.WFDiagram	getDiagram() Liest das WFDiagramm zu diesem Workflow.
de.elo.ix.client.EditInfo	getEditInfo() Liefert das zugehörige EditInfo-Objekt zurück.
int	getId() Liefert die ObjektID des Archiveintrags zurück auf den sich diese Aufgabe bezieht.
java.lang.String	getName() Liefert die Kurzbezeichnung dieses Elements.
de.elo.ix.client.WFNode[]	getSuccessorsList() Liefert eine Liste mit den Nachfolgerknoten des aktiven Workflowknotens zurück.
de.elo.ix.client.WFNode[]	getSuccessorsList(de.elo.ix.client.WFNode wfNode) Liefert eine Liste mit den Nachfolgerknoten für den übergebenen Workflowknoten zurück.
boolean	isDocument() Liefert true, wenn dies Aufgabe sich auf ein Dokument bezieht.
boolean	isStructure() Liefert true, wenn dies Aufgabe sich auf einen Ordner bezieht.
de.elo.ix.client.Sord	loadSord() Lädt die aktuelle Verschlagwortung (vom Server oder (in der Postbox) aus der zugehörigen ESW-Datei).
void	releaseWorkflowNode(int userId) Gibt den aktiven Workflowknoten ab.
void	releaseWorkflowNode(java.lang.String userName) Gibt den aktiven Workflowknoten ab.
void	returnNodeToGroup() Angenommener Workflowknoten an Gruppe zurückgeben.
boolean	saveDiagram() Speichert das geänderte WFDiagram und entfernt die Sperre auf dem Workflow.
boolean	setDiagram(de.elo.ix.client.WFDiagram wfDiagram) Setzt das WFDiagramm für diesen Workflow.
boolean	setLock() Setzt eine Sperre auf den Workflow.
void	setNode(int nodeId, de.elo.ix.client.WFNode wfNode) Setzt die Daten des angegebenen Workflowknotens in diesem Workflow.
void	setSord(de.elo.ix.client.Sord sord) Setzt das angegebene SORD-Objekt als neue Verschlagwortung.
void	takeWorkflowNode() Nimmt den aktiven Workflowknoten an.
boolean	unlock() Entfernt die Sperre auf diesem Workflow.

Methods inherited from class de.elo.client.scripting.items.TaskElement

getTask, isReminder, isWorkflow

Methods inherited from class de.elo.client.scripting.items.IndexedElement

getDocMaskId, getDocMaskName, getHiddenText, getObjKeyValue, getObjKeyValue, getProperties, getSord, saveSord, setHiddenText, setMaskId, setName, setObjKeyValue, setObjKeyValue, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowElement

public WorkflowElement(de.elo.client.maindialog.Workspace workspace,
                       de.elo.ix.client.UserTask task)

Konstruktor für die Klasse "WorkflowElement".

Parameters:

workspace - Aktueller Arbeitsbereich

task - Index Server Objekt für eine Anwenderaufgabe

Method Detail

delegateWorkflowNode

public void delegateWorkflowNode(int userId,
                                 java.lang.String nodeName,
                                 java.lang.String nodeComment,
                                 boolean workflowRetoure)

Delegiert den aktiven Workflowknoten an den übergebenen Anwender/Gruppe.

Parameters:

userId - AnwenderId, an dem das Workflow delegiert wird

nodeName - Bezeichnung des aktiven Workflowknotens

nodeComment - Kommentar des aktiven Workflowknotens

workflowRetoure - Benachrichtigung beim Abschluß

Since:

7.00.004

delegateWorkflowNode

public void delegateWorkflowNode(java.lang.String userName,
                                 java.lang.String nodeName,
                                 java.lang.String nodeComment,
                                 boolean workflowRetoure)

Delegiert den aktiven Workflowknoten an den übergebenen Anwender/Gruppe.

Parameters:

userName - Anwender/Gruppe, an dem das Workflow delegiert wird

nodeName - Bezeichnung des aktiven Workflowknotens

nodeComment - Kommentar des aktiven Workflowknotens

workflowRetoure - Benachrichtigung beim Abschluß

Since:

7.00.004

takeWorkflowNode

public void takeWorkflowNode()
                      throws java.lang.Exception

Nimmt den aktiven Workflowknoten an.

Throws:

java.lang.Exception

Since:

7.00.004

releaseWorkflowNode

public void releaseWorkflowNode(int userId)
                         throws java.lang.Exception

Gibt den aktiven Workflowknoten ab.

Parameters:

userId - AnwenderId, an dem der Knoten abgegeben wird

Throws:

java.lang.Exception

Since:

7.00.004

releaseWorkflowNode

public void releaseWorkflowNode(java.lang.String userName)
                         throws java.lang.Exception

Gibt den aktiven Workflowknoten ab.

Parameters:

userName - Anwender- oder Gruppenname, an dem der Knoten abgegeben wird

Throws:

java.lang.Exception

Since:

7.00.004

getSuccessorsList

public de.elo.ix.client.WFNode[] getSuccessorsList()
                                            throws java.rmi.RemoteException

Liefert eine Liste mit den Nachfolgerknoten des aktiven Workflowknotens zurück.

Returns:

WFNode[] Liste mit Nachfolgerknoten

Throws:

java.rmi.RemoteException

Since:

7.00.004

getSuccessorsList

public de.elo.ix.client.WFNode[] getSuccessorsList(de.elo.ix.client.WFNode wfNode)
                                            throws java.rmi.RemoteException

Liefert eine Liste mit den Nachfolgerknoten für den übergebenen Workflowknoten zurück.

Parameters:

wfNode - Workflow-Knoten, dessen Nachfolgeknoten ermittelt werden sollen

Returns:

Liste mit Nachfolgerknoten

Throws:

java.rmi.RemoteException

Since:

7.00.006

getDiagram

public de.elo.ix.client.WFDiagram getDiagram()
                                      throws java.rmi.RemoteException

Liest das WFDiagramm zu diesem Workflow. Hierbei wird eine Sperre auf den Workflow gesetzt, welche am Ende mit der Methode "unlock", "setDiagram" oder "saveDiagram" wieder entfernt werden muss.

Returns:

Definition des Workflows

Throws:

java.rmi.RemoteException

Since:

7.00.006

setDiagram

public boolean setDiagram(de.elo.ix.client.WFDiagram wfDiagram)

Setzt das WFDiagramm für diesen Workflow. Dabei wird die Sperre auf den Workflow entfernt.

Parameters:

wfDiagram - Workflow-Diagramm

Returns:

True wenn das Workflow-Diagramm gesetzt wurde, False bei einem Fehler

Since:

7.00.006

saveDiagram

public boolean saveDiagram()

Speichert das geänderte WFDiagram und entfernt die Sperre auf dem Workflow. Dies ist nach Änderungen am Diagramm welche z.B. per "setNode" vorgenommen wurden notwendig.

Returns:

True wenn das Diagramm gespeichert wurde, False bei einem Fehler

Since:

7.00.006

unlock

public boolean unlock()

Entfernt die Sperre auf diesem Workflow.

Returns:

True wenn die Sperre entfernt wurde oder keine Sperre vorhanden war, False wenn die Sperre nicht entfernt werden konnte

Since:

7.00.006

setLock

public boolean setLock()

Setzt eine Sperre auf den Workflow.

Returns:

True wenn die Sperre gesetzt werden konnte, False sonst

Since:

7.00.014

setNode

public void setNode(int nodeId,
                    de.elo.ix.client.WFNode wfNode)
             throws java.rmi.RemoteException

Setzt die Daten des angegebenen Workflowknotens in diesem Workflow.

Parameters:

nodeId - ID des Workflowknotens, welcher gesetzt werden soll

wfNode - Workflowknoten

Throws:

java.rmi.RemoteException

Since:

7.00.006

confirmFlow

public void confirmFlow(java.lang.String name,
                        java.lang.String comment,
                        int[] successorIds)
                 throws java.rmi.RemoteException

Leitet das Workflow an die angegebenen Nachfolger weiter.

Parameters:

name - Name des aktiven Knotens. Bei "null" wird der Name des aktiven Knotens verwendet

comment - Kommentar des aktiven Knotens. Bei "null" wird der Kommentar des aktiven Knotens verwendet

successorIds - Liste mit den Ids der Nachfolgerknoten

Throws:

java.rmi.RemoteException

Since:

7.00.004

confirmFlow

public void confirmFlow(int[] successorIds)
                 throws java.rmi.RemoteException

Leitet das Workflow an die angegebenen Nachfolger weiter.

Parameters:

successorIds - Liste mit den Ids der Nachfolgerknoten

Throws:

java.rmi.RemoteException

Since:

8.00.006

returnNodeToGroup

public void returnNodeToGroup()
                       throws java.rmi.RemoteException

Angenommener Workflowknoten an Gruppe zurückgeben.

Throws:

java.rmi.RemoteException

Since:

7.00.004

del

public boolean del()
            throws java.lang.Exception

Löscht diesen Workflow.

Specified by:

del in class TaskElement

Returns:

True wenn erfolgreiche gelöscht wurde, False bei Fehlern

Throws:

java.lang.Exception

Since:

7.00.004

getArchiveElement

public ArchiveElement getArchiveElement()
                                 throws java.lang.Exception

Description copied from class: TaskElement

Liefert den zu der Aufgabe gehörenden Archiveintrag.

Specified by:

getArchiveElement in class TaskElement

Returns:

Archive-Eintrag (Dokument oder Ordner) zu dieser Aufgabe.

Throws:

java.lang.Exception

loadSord

public de.elo.ix.client.Sord loadSord()
                               throws java.lang.Exception

Description copied from class: IndexedElement

Lädt die aktuelle Verschlagwortung (vom Server oder (in der Postbox) aus der zugehörigen ESW-Datei).

Specified by:

loadSord in class IndexedElement

Returns:

Sord

Throws:

java.lang.Exception

Since:

8.01.000

getEditInfo

public de.elo.ix.client.EditInfo getEditInfo()

Description copied from class: IndexedElement

Liefert das zugehörige EditInfo-Objekt zurück.

Specified by:

getEditInfo in class IndexedElement

Returns:

EditInfo

Since:

8.01.000

setSord

public void setSord(de.elo.ix.client.Sord sord)
             throws java.lang.Exception

Description copied from class: IndexedElement

Setzt das angegebene SORD-Objekt als neue Verschlagwortung.

Specified by:

setSord in class IndexedElement

Parameters:

sord - Verschlagwortungsinformation

Throws:

java.lang.Exception

Since:

8.01.000

isDocument

public boolean isDocument()

Description copied from class: TaskElement

Liefert true, wenn dies Aufgabe sich auf ein Dokument bezieht.

Specified by:

isDocument in class TaskElement

Returns:

boolean

Since:

8.01.000

isStructure

public boolean isStructure()

Description copied from class: TaskElement

Liefert true, wenn dies Aufgabe sich auf einen Ordner bezieht.

Specified by:

isStructure in class TaskElement

Returns:

boolean

Since:

8.01.000

getChildren

public java.util.Enumeration<ArchiveElement> getChildren()

Description copied from class: TaskElement

Liefert eine Aufzählung aller Einträge (als ArchiveElement-Objekte ArchiveDokument oder StructureElement), falls sich die Aufgabe auf einen Ordner bezieht.

Specified by:

getChildren in class TaskElement

Returns:

Aufzählung mit Unterelementen

Since:

8.01.000

getId

public int getId()

Description copied from class: TaskElement

Liefert die ObjektID des Archiveintrags zurück auf den sich diese Aufgabe bezieht.

Specified by:

getId in class TaskElement

Returns:

int

Since:

8.01.000

getName

public java.lang.String getName()
                         throws java.lang.Exception

Description copied from class: IndexedElement

Liefert die Kurzbezeichnung dieses Elements.

Overrides:

getName in class IndexedElement

Returns:

Kurzbezeichnung

Throws:

java.lang.Exception

Since:

8.01.000