com.groiss.wf

Interface RemoteWfEngine

All Superinterfaces:

Remote

All Known Subinterfaces:

WfEngine

public interface RemoteWfEngine
extends Remote

This interface encapsulates the functionality of the @enterprise workflow engine. An object implementing this interface can be created on the server or the client.

Most methods have an implicit user parameter. This is initialized as the ThreadPrincipal from the ThreadContext when the WfEngine object is created.

Field Summary

Fields

Modifier and Type	Field and Description
static short	INVISIBLE
static short	MUST
static short	NO_ADDDEL
static short	READ_ONLY
static short	READ_WRITE
static short	TEXT

Method Summary

Modifier and Type	Method and Description
void	abort(ProcessInstance process) Abort a process.
void	abort(ProcessInstance process, String comment) Abort a process and add a DMSNote with a generated Subject and a given comment.
void	abortParforSiblings(ActivityInstance parfor) Abort the running siblings of the current parfor instances.
void	abortSiblings(ActivityInstance join) Abort the siblings of the par branch.
void	addAgent(ActivityInstance ai, Agent a, OrgUnit ou, DMSNote note) Add an agent which receives the process after the current agent
int	addParforInstances(String stepid, ActivityInstance previous) Start additional parfor branches for the given step.
void	addSystemNote(ActivityInstance ai, String subject, String text) Attach a note to an ActivityInstance.
void	archive(ProcessInstance process) Archive a process.
void	canTake(ActivityInstance ai) Check if the thread-user can take the activity.
ActivityInstance	changeAgent(ActivityInstance ai, Agent a, OrgUnit ou, String comment) Give the activity instance to another agent.
void	checkAbort(ProcessInstance process) Check if the thread user may abort the process.
void	closePredecessor(ActivityInstance ai) If the predecessor of ai was not finished completely (is in status WAITING) and the necessary action is done now (for example setting the agent for ai) this method will complete it.
ActivityInstance	copyTo(ActivityInstance ai, User u) Send a copy to another user.
ActivityInstance	copyTo(ActivityInstance ai, User u, String comment) Send a copy to another user.
ProcessInstance	createProcessInstance(ProcessDefinition p, User u, OrgUnit d, Date duedate, String id) Create a process instance.
ProcessInstance	createProcessInstance(ProcessDefinition p, User u, OrgUnit d, Date duedate, String id, DMSForm f) Create a process instance.
void	filterByFolder(UserFolder uf, List<ActivityInstance> ais) Filter a list of ActivityInstances.
void	finish(ActivityInstance ai) Finsh an activity, the engine starts the next step.
void	finishChoice(ActivityInstance ai) Finishs a choice branch, abort the other branches.
List<ActivityInstance>	getActiveTasks(ProcessInstance process) Get the list of active activities of a process instance.
List<ActivityInstance>	getActiveTasks(ProcessInstance process, User u) Get the list of active, interactive activities of a process instance assigned to a user.
List<ActivityInstance>	getActivities(String condition) Find the activity instances with a given condition.
ActivityInstance	getActivityInstance(long oid) Find a activity instance from the given oid.
List<ActivityInstance>	getActivityInstances(ProcessInstance process) Get the list of all direct activity instances of a process instance.
List<ActivityInstance>	getActivityInstances(ProcessInstance process, boolean recursive, boolean active, int type, String steplabel) Get a list of activity instances for a process instance
List<ActivityInstance>	getActivityInstances(ProcessInstance process, String steplabel) Get the list of direct activity instances of a particular step in a process.
List<ActivityInstance>	getAllCurrentActivityInstances(ProcessInstance process) Get the list of ALL active activities of a process instance.
List<ActivityInstance>	getAllInteractiveTasks(ProcessInstance process) Get the list of ALL active, interactive activities of a process instance.
List<List<ActivityInstance>>	getChoiceSteps(ActivityInstance ai) Use this method to get the possible choice branches when the process execution reaches a choice.
ActivityInstance	getContext() Return the current activity instance.
List<DMSObject>	getDocuments(ProcessInstance process) Get the list of DMS objects (e.g. documents, folders) attached to a process.
Map<String,Short>	getFieldModes(ActivityInstance ai, DMSForm f) Get field modes for form fields
Map<String,Short>	getFieldModes(ActivityInstance ai, DMSForm form, DMSForm mainform, String id) Get field modes for form fields and subforms
<P extends DMSForm> P	getForm(ActivityInstance ai, String id) Get a form of a process.
List<DMSForm>	getForms(ProcessInstance process) Get the forms of a process.
PersistentVersion	getFormVersion(DMSForm form, ActivityInstance ai) Returns the version of the passed form in the context of the passed activity instance.
ProcessInstance	getMainProcess(ActivityInstance ai) Get the root of the activity instance tree
List<DMSNote>	getNotes(ProcessInstance process) Get the notes to a process instances
ProcessInstance	getParent(ActivityInstance ai) Get the process instance of the given activity instance.
ProcessInstance	getProcess(DMSForm f) Find the process instance where the given form is attached.
ProcessInstance	getProcess(long oid) Find a process instance from the given oid.
ProcessInstance	getProcess(String id) Find a process instance with the given id.
ProcessDefinition	getProcessDefinition(String id) Find a process definition with the given id and status=active, if more than one is found, the process definition with the highest version number is returned.
ProcessDefinition	getProcessDefinition(String id, int version) Find a process definition with the given id and version.
List<ProcessInstance>	getProcesses(String condition) Find the process instances with a given condition.
ProcessInstance	getProcessFromForm(long formoid) Find a process instance from the oid of a form.
List<ActivityInstance>	getRoleSuspensionList(Application a) Get the role suspension list of the current user.
List<ActivityInstance>	getRoleWorklist(Application a) Get the role worklist of the current user.
String	getServerProperty(String prop) Returns a property from the server
List<Pair<ProcessDefinition,List<Pair<String,List<OrgUnit>>>>>	getStartableProcDefs(Application appl) List the process definitions of the given application, which are startable for the user.
List<Pair<ProcessDefinition,List<OrgUnit>>>	getStartableProcesses(Application appl) Deprecated. use getStartableProcDefs
List<Pair<String,List<OrgUnit>>>	getStartInfo(ProcessDefinition pd) Returns the start info for the given process for the current thread user.
RemoteStore	getStore() Return the underlying store.
List<ActivityInstance>	getSuspensionList(Application a) Get the personal suspension list of the current user.
List<Suspension>	getSuspensions(ActivityInstance ai) Find out when and how the activity instance was in the suspension list.
Task	getTask(String id) Find a task with the given id and status=active, if more than one is found, the task with the highest version number is returned.
Task	getTask(String id, int version) Find a task with the given id and version.
List<UserFolder>	getUserFolders() Get the list of UserFolders of the current user.
List<ActivityInstance>	getWaitingList(Application a) Get the list of waiting activities of the current user.
List<ActivityInstance>	getWorklist(Application a, boolean withRepr) Get the worklist of the current user.
List<ActivityInstance>	getWorkList(EnumSet<WorklistKind> wlKinds, Application a) Get a combined worklist of the combination (union) of the desired kinds for the current user.
List<ActivityInstance>	getWorkList(WorklistKind wlKind, Application a) Get a worklist of the desired kind for the current user.
ActivityInstance	goBack(ActivityInstance ai, ActivityInstance ai2, String comment) Go back to a previous step.
void	goBackToLastInteractive(ActivityInstance ai, String comment)
ActivityInstance	gotoStep(ActivityInstance ai, String steplabel, Agent ag, OrgUnit ou, String comment) Goto another step.
void	gotoTask(ActivityInstance ai, String stepname, Agent ag, OrgUnit ou, String comment) Deprecated. use gotoStep
void	gotoTask(ProcessInstance process, String taskid, Agent ag, String comment) Deprecated. the method behaves unpredictabe when more than one activity instance of the process is active and when the task appears more than once in the process definition. use gotoStep
boolean	hasDocuments(ProcessInstance process) Has the process documents attached?
boolean	hasForm(ActivityInstance ai, String id) Check if the process has a form with given id.
boolean	hasNotes(ProcessInstance process) Has the process notes attached?
boolean	hasSeen(ActivityInstance ai) Returns true if the ActivityInstance has been seen by the current user.
boolean	isVisible(ActivityInstance ai) Determines whether an ActivityInstance is visible for the current user.
List<PersistentVersion>	listFormVersions(ActivityInstance ai) Returns a list of form versions (at most one for each process form) which were made in the context of the passed activity instance.
List<ActivityInstance>	listPredecessors(ActivityInstance ai) Return the list of predecessor steps of an activity instance.
List<Pair<ActivityInstance,List<ActivityInstance>>>	listPreviousSteps(ActivityInstance ai) List the previous steps of the process (possible go back targets).
List<ProcessDefinition>	listProcessDefinitions(Application appl) List the process definitions of the given application
List<ActivityInstance>	listSuccessors(ActivityInstance ai) Return the list of successor steps of an activity instance.
ActivityInstance	makeBranch(ProcessInstance process, Task t, Agent a, OrgUnit d) Insert a new step to the running process.
void	makeBranch(ProcessInstance process, Task t, Agent a, OrgUnit d, List<String> forms) Deprecated. use method without form argument
ActivityInstance	makeVersion(ActivityInstance ai, String desc, boolean withDocs) Versions the passed activity instance, the process forms and the documents (optional) and returns a new activity instance which is a copy of the passed one.
Map<ActivityInstance,UserFolder>	mapToUserFolders(List<ActivityInstance> ais) Map a list of ActivityInstances to their corresponding UserFolders.
void	propagateChange(ActivityInstance ai) Inform the system that a change to an ActivityInstance has been made.
void	propagateProcessChange(ProcessInstance pi) Inform the system that a process instance has been changed.
void	reactivate(ProcessInstance process) Reactivate a process.
void	reactivate(ProcessInstance process, String comment) Reactivate a process.
void	reactivateAndTake(ProcessInstance process, String comment) Reactivate a process and take the reactivated tasks.
void	refreshWLCache(User u) Refresh the organizational data in the WorklistCache for a particular user.
void	refreshWLCacheOrgData() Refresh the organizational data in the worklist cache.
void	removeSeens(ActivityInstance ai, boolean meToo) Delete the seen information for the given ai.
void	seeAgain(ActivityInstance ai) Move the activity instance from the suspension list to the worklist.
void	seeLater(ActivityInstance ai, Date d) Move the activity instance from the worklist to the suspension list.
void	seeLater(ActivityInstance ai, Date d, String description) Move the activity instance from the worklist to the suspension list.
void	setAgent(ActivityInstance ai, Agent a) Give the activity instance to another agent.
void	setCheckedOut(ActivityInstance ai, boolean state) Set the activityInstance as checcked out or in (i.e. is on mobile server)
void	setContext(ActivityInstance ai)
void	setDescription(ActivityInstance ai, String descr) Set the description of an activity instance.
void	setDuedate(ActivityInstance ai, Date d) Set the duedate of the activity instance.
void	setFinished(ActivityInstance ai) Set the status of the activity instance to FINISHED.
void	setId(ProcessInstance pi, String s) Set the id of the process instance.
void	setOrgUnit(ActivityInstance ai, OrgUnit d) Change the organizational unit of a process.
void	setPriority(ProcessInstance pi, int priority) Set the priority of the process instance.
void	setSeen(ActivityInstance ai, boolean seen) Set the given ActivityInstance to seen/unseen for the current user.
void	setStepAgent(ActivityInstance ai, Agent a) Set the step-agent of the activity instance to another agent.
void	setSubject(ProcessInstance process) Set the subject of the process instance according to the definition in the process definition.
void	setSubjectToString(ProcessInstance process, String str) Set the subject of the process instance o the given string value.
void	start(ProcessInstance pi) Start a process instance, which was previously created, but not started.
void	startBranch(ProcessInstance process, String branchid) Start a branch.
ProcessInstance	startProcess(ProcessDefinition p, User u, OrgUnit d, Date duedate, String id) Start a process.
ProcessInstance	startProcess(ProcessDefinition p, User u, OrgUnit d, Date duedate, String id, DMSForm f) Start a process.
ActivityInstance	take(ActivityInstance ai) Take an activity: move it from the role-worklist to the worklist.
ActivityInstance	untake(ActivityInstance ai) Put back an activity: move it from the worklist to the role-worklist.
void	updateForm(DMSForm f) Update the form (make the changes persistent).

Field Detail

INVISIBLE

static final short INVISIBLE

See Also:

Constant Field Values

READ_ONLY

static final short READ_ONLY

See Also:

Constant Field Values

READ_WRITE

static final short READ_WRITE

See Also:

Constant Field Values

TEXT

static final short TEXT

See Also:

Constant Field Values

MUST

static final short MUST

See Also:

Constant Field Values

NO_ADDDEL

static final short NO_ADDDEL

See Also:

Constant Field Values

Method Detail

getStore

RemoteStore getStore()
              throws RemoteException

Return the underlying store.

Returns:

a store object

Throws:

RemoteException

getProcessDefinition

ProcessDefinition getProcessDefinition(String id)
                                throws RemoteException

Find a process definition with the given id and status=active, if more than one is found, the process definition with the highest version number is returned.

Parameters:

id - the id of the process

Returns:

a process definition

Throws:

RemoteException

getProcessDefinition

ProcessDefinition getProcessDefinition(String id,
                                       int version)
                                throws RemoteException

Find a process definition with the given id and version.

Parameters:

id - the id of the process

version - the version of the process

Returns:

a process definition

Throws:

RemoteException

listProcessDefinitions

List<ProcessDefinition> listProcessDefinitions(Application appl)
                                        throws RemoteException

List the process definitions of the given application

Parameters:

appl - the application

Returns:

a list of ProcessDefinition objects

Throws:

RemoteException

getStartableProcesses

@Deprecated
List<Pair<ProcessDefinition,List<OrgUnit>>> getStartableProcesses(Application appl)
                                                                       throws RemoteException

Deprecated. use getStartableProcDefs

List the process definitions of the given application, which are startable for the user. A process is startable, if it is active and the agent of the first step is either the user or a role the user has.

Returns:

the list of pairs of processes and lists of OrgUnits

Throws:

RemoteException

getStartableProcDefs

List<Pair<ProcessDefinition,List<Pair<String,List<OrgUnit>>>>> getStartableProcDefs(Application appl)
                                                                             throws RemoteException

List the process definitions of the given application, which are startable for the user. A process is startable, if it is active and the agent of a start task is either the user or a role the user has. A start task is a task where between the task and the begin node is no interactive task.

Parameters:

appl - optional application restriction

Returns:

a list of pairs of processes and lists of pairs of step-labels and lists of org-units

Throws:

RemoteException

getStartInfo

List<Pair<String,List<OrgUnit>>> getStartInfo(ProcessDefinition pd)
                                       throws RemoteException

Returns the start info for the given process for the current thread user. If this user cannot start the process, the result is empty.

Parameters:

pd - a process definition

Returns:

the list of pairs of step-labels and lists of OrgUnits

Throws:

RemoteException

getTask

Task getTask(String id)
      throws RemoteException

Find a task with the given id and status=active, if more than one is found, the task with the highest version number is returned.

Parameters:

id - the id of the task

Returns:

a task, null if no task has the given id

Throws:

RemoteException

getTask

Task getTask(String id,
             int version)
      throws RemoteException

Find a task with the given id and version.

Parameters:

id - the id of the task

version - the version of the task

Returns:

a task

Throws:

RemoteException

startProcess

ProcessInstance startProcess(ProcessDefinition p,
                             User u,
                             OrgUnit d,
                             Date duedate,
                             String id)
                      throws RemoteException

Start a process. ProcessDefinition and OrgUnit must not be null.

Parameters:

p - the process definition

u - the user

d - the org. unit

duedate - the duedate

id - the id of the process instance

Returns:

the process instance

Throws:

RemoteException

startProcess

ProcessInstance startProcess(ProcessDefinition p,
                             User u,
                             OrgUnit d,
                             Date duedate,
                             String id,
                             DMSForm f)
                      throws RemoteException

Start a process. ProcessDefinition and OrgUnit must not be null. The form must be already in the database.

Parameters:

p - the process definition

u - the user

d - the org. unit

duedate - the duedate

id - the id of the process instance

f - a form

Returns:

the process instance

Throws:

RemoteException

createProcessInstance

ProcessInstance createProcessInstance(ProcessDefinition p,
                                      User u,
                                      OrgUnit d,
                                      Date duedate,
                                      String id)
                               throws RemoteException

Create a process instance. ProcessDefinition and OrgUnit must not be null. The process instance waits at the begin step until this activityinstance will be finished explicitely, or until start(pi) is called.

Parameters:

p - the process definition

u - the user

d - the org. unit

duedate - the duedate

id - the id of the process instance

Returns:

the process instance

Throws:

RemoteException

createProcessInstance

ProcessInstance createProcessInstance(ProcessDefinition p,
                                      User u,
                                      OrgUnit d,
                                      Date duedate,
                                      String id,
                                      DMSForm f)
                               throws RemoteException

Create a process instance. ProcessDefinition and OrgUnit must not be null. The process instance waits at the begin step until this activityinstance will be finished explicitely, or until start(pi) is called.

Parameters:

p - the process definition

u - the user

d - the org. unit

duedate - the duedate

id - the id of the process instance

f - a form

Returns:

the process instance

Throws:

RemoteException

start

void start(ProcessInstance pi)
    throws RemoteException

Start a process instance, which was previously created, but not started.

Parameters:

pi - the process instance to start

Throws:

RemoteException

getWorklist

List<ActivityInstance> getWorklist(Application a,
                                   boolean withRepr)
                            throws RemoteException

Get the worklist of the current user.

Parameters:

a - the application, if null return work items for all applications

withRepr - if true add the work items assigned to persons the user substitutes.

Returns:

a list of activity instances

Throws:

RemoteException

getWaitingList

List<ActivityInstance> getWaitingList(Application a)
                               throws RemoteException

Get the list of waiting activities of the current user.

Parameters:

a - the application, if null return waiting items for all applications

Returns:

a list of activity instances

Throws:

RemoteException

getRoleWorklist

List<ActivityInstance> getRoleWorklist(Application a)
                                throws RemoteException

Get the role worklist of the current user.

Parameters:

a - the application, if null return work items for all applications

Returns:

a list of activity instances

Throws:

RemoteException

getSuspensionList

List<ActivityInstance> getSuspensionList(Application a)
                                  throws RemoteException

Get the personal suspension list of the current user.

Parameters:

a - the application, if null return work items for all applications

Returns:

a list of activity instances

Throws:

RemoteException

getRoleSuspensionList

List<ActivityInstance> getRoleSuspensionList(Application a)
                                      throws RemoteException

Get the role suspension list of the current user.

Parameters:

a - the application, if null return work items for all applications

Returns:

a list of activity instances

Throws:

RemoteException

getWorkList

List<ActivityInstance> getWorkList(WorklistKind wlKind,
                                   Application a)
                            throws RemoteException

Get a worklist of the desired kind for the current user.

Parameters:

wlKind - the kind of worklist to be returned

a - the application, if null return work items for all applications

Returns:

a list of activity instances

Throws:

RemoteException

getWorkList

List<ActivityInstance> getWorkList(EnumSet<WorklistKind> wlKinds,
                                   Application a)
                            throws RemoteException

Get a combined worklist of the combination (union) of the desired kinds for the current user.

Parameters:

wlKinds - the kinds of worklists to be returned

a - the application, if null return work items for all applications

Returns:

a list of activity instances

Throws:

RemoteException

isVisible

boolean isVisible(ActivityInstance ai)
           throws RemoteException

Determines whether an ActivityInstance is visible for the current user. It is visible when one of the worklists of the current user contains the ai.

Parameters:

ai -

Returns:

true, if the passed ActivityInstance is in one of the worklists of the user (personal, role, suspension, rolesuspension, pending, or via representation)

Throws:

RemoteException

getProcess

ProcessInstance getProcess(String id)
                    throws RemoteException

Find a process instance with the given id. If more than one process instances qualify, then ApplicationException(1125) will be thrown.

Parameters:

id - the process instance id

Returns:

the process instance

Throws:

RemoteException

getProcess

ProcessInstance getProcess(long oid)
                    throws RemoteException

Find a process instance from the given oid.

Parameters:

oid - the process instance oid

Returns:

the process instance

Throws:

RemoteException

getProcessFromForm

ProcessInstance getProcessFromForm(long formoid)
                            throws RemoteException

Find a process instance from the oid of a form.

Parameters:

formoid - the oid of a process form

Returns:

the process instance

Throws:

RemoteException

getActivityInstance

ActivityInstance getActivityInstance(long oid)
                              throws RemoteException

Find a activity instance from the given oid.

Parameters:

oid - the activity instance oid

Returns:

the process instance

Throws:

RemoteException

getProcess

ProcessInstance getProcess(DMSForm f)
                    throws RemoteException

Find the process instance where the given form is attached. The method returns a process if and only if the form is a process form. It returns null for subforms. It always returns the "latest" process-instance (latest started, highest oid). This is important, if a form is attached to more than one process instance, for example a parfor in an iteration.

Parameters:

f - the form

Returns:

the process instance

Throws:

RemoteException

getProcesses

List<ProcessInstance> getProcesses(String condition)
                            throws RemoteException

Find the process instances with a given condition.

Parameters:

condition - a SQL where clause

Returns:

a list of process instances

Throws:

RemoteException

getActivities

List<ActivityInstance> getActivities(String condition)
                              throws RemoteException

Find the activity instances with a given condition.

Parameters:

condition - a SQL where clause

Returns:

a list of activity instances

Throws:

RemoteException

getAllCurrentActivityInstances

List<ActivityInstance> getAllCurrentActivityInstances(ProcessInstance process)
                                               throws RemoteException

Get the list of ALL active activities of a process instance. ATTENTION: this method returns all tasks with Type =ActivityInstance.TASK), as well as all longrunning activity instances [Type in (ActivityInstance.SYSTEM_WAIT, ActivityInstance.BATCH, ActivityInstance.WS_INVOKE, ActivityInstance.WS_RECEIVE, ActivityInstance.WAIT)] ActivityInstances of the given ProcessInstance, even ALL children of ActivityInstance.PROCESS, ActivityInstance.PARFOR and ActivityInstance.SCOPE will be returned

Parameters:

process - the process instance

Returns:

a list of activity instances

Throws:

RemoteException

getAllInteractiveTasks

List<ActivityInstance> getAllInteractiveTasks(ProcessInstance process)
                                       throws RemoteException

Get the list of ALL active, interactive activities of a process instance. ATTENTION: this method returns all interactive (Type =ActivityInstance.TASK) ActivityInstances of the given ProcessInstance, even ALL children of ActivityInstance.PROCESS, ActivityInstance.PARFOR and ActivityInstance.SCOPE will be returned

Parameters:

process - the process instance

Returns:

a list of activity instances

Throws:

RemoteException

getActiveTasks

List<ActivityInstance> getActiveTasks(ProcessInstance process)
                               throws RemoteException

Get the list of active activities of a process instance. ATTENTION: this method returns all types of ActivityInstance, but doesn't return ALL ActivityInstances of the given ProcessInstance. children of ActivityInstance.PROCESS, ActivityInstance.PARFOR and ActivityInstance.SCOPE will not be returned

Parameters:

process - the process instance

Returns:

a list of activity instances

Throws:

RemoteException

getActiveTasks

List<ActivityInstance> getActiveTasks(ProcessInstance process,
                                      User u)
                               throws RemoteException

Get the list of active, interactive activities of a process instance assigned to a user. ATTENTION: this method returns only interactive (Type =ActivityInstance.TASK) ActivityInstances of the given ProcessInstance, but doesn't return ALL interactive ActivityInstances of the given ProcessInstance. children of ActivityInstance.PROCESS, ActivityInstance.PARFOR and ActivityInstance.SCOPE will not be returned

Parameters:

u - the user

process - the process instance

Returns:

a list of activity instances

Throws:

RemoteException

getActivityInstances

List<ActivityInstance> getActivityInstances(ProcessInstance process)
                                     throws RemoteException

Get the list of all direct activity instances of a process instance.

ATTENTION: this method doesn't return ALL ActivityInstances of the given ProcessInstance. children of ActivityInstance.PROCESS, ActivityInstance.PARFOR and ActivityInstance.SCOPE will not be returned

Parameters:

process - the process instance

Returns:

a list of activity instances

Throws:

RemoteException

getActivityInstances

List<ActivityInstance> getActivityInstances(ProcessInstance process,
                                            String steplabel)
                                     throws RemoteException

Get the list of direct activity instances of a particular step in a process.

ATTENTION: this method doesn't return ALL ActivityInstances of the given ProcessInstance. children of ActivityInstance.PROCESS, ActivityInstance.PARFOR and ActivityInstance.SCOPE will not be returned

Parameters:

process - the process instance

steplabel - the label of the step

Returns:

a list of activity instances

Throws:

RemoteException

getActivityInstances

List<ActivityInstance> getActivityInstances(ProcessInstance process,
                                            boolean recursive,
                                            boolean active,
                                            int type,
                                            String steplabel)
                                     throws RemoteException

Get a list of activity instances for a process instance

Parameters:

process - the process instance

recursive - if true, also nested activity instances will be returned

active - if true, only active activity instances will be returned

type - of activity instances to return, if all types should be returned, use ActivityInstance.ALL

steplabel - restrict the results by label of the step, use null if no restriction intended

Returns:

Throws:

RemoteException

getDocuments

List<DMSObject> getDocuments(ProcessInstance process)
                      throws RemoteException

Get the list of DMS objects (e.g. documents, folders) attached to a process.

Parameters:

process - the process instance

Returns:

a list of DMSObject

Throws:

RemoteException

getForm

<P extends DMSForm> P getForm(ActivityInstance ai,
                              String id)
                       throws RemoteException

Get a form of a process.

Parameters:

ai - the process instance or an activity instance of the process

id - the id of the form in the process

Returns:

the form

Throws:

RemoteException

hasForm

boolean hasForm(ActivityInstance ai,
                String id)
         throws RemoteException

Check if the process has a form with given id.

Parameters:

ai - the process instance or an activity instance of the process

id - the id of the form in the process

Returns:

true if the form exists

Throws:

RemoteException

getForms

List<DMSForm> getForms(ProcessInstance process)
                throws RemoteException

Get the forms of a process.

Parameters:

process - the process instance

Returns:

the forms (DMSForm objects)

Throws:

RemoteException

getMainProcess

ProcessInstance getMainProcess(ActivityInstance ai)
                        throws RemoteException

Get the root of the activity instance tree

Parameters:

ai - an activity instance

Returns:

the process instance of the main process of the given activity instance.

Throws:

RemoteException

getParent

ProcessInstance getParent(ActivityInstance ai)
                   throws RemoteException

Get the process instance of the given activity instance.

Parameters:

ai - an activity instance

Returns:

the process instance

Throws:

RemoteException

getNotes

List<DMSNote> getNotes(ProcessInstance process)
                throws RemoteException

Get the notes to a process instances

Parameters:

process - a process instance

Returns:

a list of notes (DMSNote objects)

Throws:

RemoteException

hasDocuments

boolean hasDocuments(ProcessInstance process)
              throws RemoteException

Has the process documents attached?

Parameters:

process - a process instance

Returns:

true if documents are present

Throws:

RemoteException

hasNotes

boolean hasNotes(ProcessInstance process)
          throws RemoteException

Has the process notes attached?

Parameters:

process - a process instance

Returns:

true if notes are present

Throws:

RemoteException

getFieldModes

Map<String,Short> getFieldModes(ActivityInstance ai,
                                DMSForm f)
                         throws RemoteException

Get field modes for form fields

Parameters:

ai - an activity instance

f - the form

Returns:

A map where the keys are the attribute names, the values are INVISIBLE, READ_ONLY, and READ_WRITE as short objects

Throws:

RemoteException

getFieldModes

Map<String,Short> getFieldModes(ActivityInstance ai,
                                DMSForm form,
                                DMSForm mainform,
                                String id)
                         throws RemoteException

Get field modes for form fields and subforms

Parameters:

ai - activity instance

form - form or sub form, may be null if mainform is set

mainform - main form, may be null if form is already contain mainform

id - subform relation id

Returns:

Map of FormFieldMode2 objects

Throws:

RemoteException

getSuspensions

List<Suspension> getSuspensions(ActivityInstance ai)
                         throws RemoteException

Find out when and how the activity instance was in the suspension list.

Parameters:

ai -

Returns:

a list of Suspensions

Throws:

RemoteException

canTake

void canTake(ActivityInstance ai)
      throws RemoteException

Check if the thread-user can take the activity.

Parameters:

ai - an activity instance

Throws:

RemoteException

take

ActivityInstance take(ActivityInstance ai)
               throws RemoteException

Take an activity: move it from the role-worklist to the worklist.

Parameters:

ai - an activity instance that is created after the take operation;
ThreadContext.getAttribute("untakenActivity") returns the activity instance which has been created before the take operation

Returns:

the activity instance now active, this may be the same as as the parameter but can alos be another object

Throws:

RemoteException

finish

void finish(ActivityInstance ai)
     throws RemoteException

Finsh an activity, the engine starts the next step.

Parameters:

ai - an activity instance

Throws:

RemoteException

getChoiceSteps

List<List<ActivityInstance>> getChoiceSteps(ActivityInstance ai)
                                     throws RemoteException

Use this method to get the possible choice branches when the process execution reaches a choice. The method returns a list of lists, each inner list contains the choice branches belonging to one choice.

Parameters:

ai -

Returns:

a list of lists of ActivityInstances

Throws:

RemoteException

finishChoice

void finishChoice(ActivityInstance ai)
           throws RemoteException

Finishs a choice branch, abort the other branches.

Parameters:

ai - the choice step on the branch you want to follows

Throws:

RemoteException

closePredecessor

void closePredecessor(ActivityInstance ai)
               throws RemoteException

If the predecessor of ai was not finished completely (is in status WAITING) and the necessary action is done now (for example setting the agent for ai) this method will complete it. If the predecessor is in another state it does nothing.

Parameters:

ai -

Throws:

RemoteException

listPreviousSteps

List<Pair<ActivityInstance,List<ActivityInstance>>> listPreviousSteps(ActivityInstance ai)
                                                               throws RemoteException

List the previous steps of the process (possible go back targets).

Parameters:

ai - current activity instance

Returns:

a list of Pairs. The first element of the pair is a previous activity instance, the second is a list of activities that must be aborted when going back to this step (for example siblings in a parallelism).

Throws:

RemoteException

goBack

ActivityInstance goBack(ActivityInstance ai,
                        ActivityInstance ai2,
                        String comment)
                 throws RemoteException

Go back to a previous step. A clone of the given previous activity instance of this process instance is created, the comment is added to the new activity.

Parameters:

ai - an activity instance

ai2 - a finished activity instance

comment - a comment

Returns:

the activity instance now active

Throws:

RemoteException

untake

ActivityInstance untake(ActivityInstance ai)
                 throws RemoteException

Put back an activity: move it from the worklist to the role-worklist.

Parameters:

ai - an activity instance that is created before the untake operation;
ThreadContext.getAttribute("untakenActivity") returns the activity instance which has been created after the take operation

Returns:

the activity instance now active

Throws:

RemoteException

seeLater

void seeLater(ActivityInstance ai,
              Date d)
       throws RemoteException

Move the activity instance from the worklist to the suspension list.

Parameters:

ai - an activity instance

d - the date, when the item should reappear in the worklist

Throws:

RemoteException

seeLater

void seeLater(ActivityInstance ai,
              Date d,
              String description)
       throws RemoteException

Move the activity instance from the worklist to the suspension list.

Parameters:

ai - an activity instance

d - the date, when the item should reappear in the worklist

description - an optional comment

Throws:

RemoteException

seeAgain

void seeAgain(ActivityInstance ai)
       throws RemoteException

Move the activity instance from the suspension list to the worklist.

Parameters:

ai - an activity instance

Throws:

RemoteException

setAgent

void setAgent(ActivityInstance ai,
              Agent a)
       throws RemoteException

Give the activity instance to another agent. Please note that this method does not set the step agent (which is needed e.g. for untake operation)!

Parameters:

ai - an activity instance

a - an agent (user or role)

Throws:

RemoteException

changeAgent

ActivityInstance changeAgent(ActivityInstance ai,
                             Agent a,
                             OrgUnit ou,
                             String comment)
                      throws RemoteException

Give the activity instance to another agent. Change is visible in process history

Parameters:

ai - an activity instance

a - an agent (user or role)

ou - an org-unit, may be null

comment - optional comment to the next agent

Throws:

RemoteException

setStepAgent

void setStepAgent(ActivityInstance ai,
                  Agent a)
           throws RemoteException

Set the step-agent of the activity instance to another agent. This is the agent where a untake of the activity instance

Parameters:

ai - an activity instance

a - an agent (user or role)

Throws:

RemoteException

gotoTask

@Deprecated
void gotoTask(ProcessInstance process,
                          String taskid,
                          Agent ag,
                          String comment)
                   throws RemoteException

Deprecated. the method behaves unpredictabe when more than one activity instance of the process is active and when the task appears more than once in the process definition. use gotoStep

Goto another task. The process flow leaves the defined route and jumps to the given task. The id of the task, an agent and a comment is given.

Parameters:

process - an processinstance instance

taskid - id of a task

ag - an agent (user or role)

comment - a comment string

Throws:

RemoteException

gotoTask

@Deprecated
void gotoTask(ActivityInstance ai,
                          String stepname,
                          Agent ag,
                          OrgUnit ou,
                          String comment)
                   throws RemoteException

Deprecated. use gotoStep

Goto another task. The process flow leaves the defined route and jumps to the given task. Preprocessing is executed.

Parameters:

ai - an activity instance

stepname - the name of a step to jump to, set the name in the process definition (editor or WDL).

ag - an agent (user or role), may be null

ou - the org.unit (may be null)

comment - a comment string

Throws:

RemoteException

gotoStep

ActivityInstance gotoStep(ActivityInstance ai,
                          String steplabel,
                          Agent ag,
                          OrgUnit ou,
                          String comment)
                   throws RemoteException

Goto another step. The process flow leaves the defined route and jumps to the given step. Preprocessing is executed if step is a task.

Parameters:

ai - an activity instance

steplabel - the label of a step to jump to, set the label in the process definition (editor or WDL).

ag - an agent (user or role), may be null. Will be ignored if the specified step is not a task

ou - the org.unit (may be null). Will be ignored if the specified step is not a task

comment - a comment string

Returns:

the ActivityInstance of the target step (defined by steplabel)

Throws:

RemoteException

copyTo

ActivityInstance copyTo(ActivityInstance ai,
                        User u)
                 throws RemoteException

Send a copy to another user.

Parameters:

ai - an activity instance

u - a user

Returns:

the copy activity instance

Throws:

RemoteException

copyTo

ActivityInstance copyTo(ActivityInstance ai,
                        User u,
                        String comment)
                 throws RemoteException

Send a copy to another user.

Parameters:

ai - an activity instance

u - a user

comment - a comment to this copy

Returns:

the copy activity instance

Throws:

RemoteException

makeBranch

@Deprecated
void makeBranch(ProcessInstance process,
                            Task t,
                            Agent a,
                            OrgUnit d,
                            List<String> forms)
                     throws RemoteException

Deprecated. use method without form argument

Insert a new step - subprocess or task - to the running process. The step is added as a branch and can be completed independent of the process.

Throws:

RemoteException

makeBranch

ActivityInstance makeBranch(ProcessInstance process,
                            Task t,
                            Agent a,
                            OrgUnit d)
                     throws RemoteException

Insert a new step to the running process. The step is added as a branch and can be completed independent of the process.

Parameters:

process - instance of the process

t - a task assigned to the process

a - a user or role

d - an optional department

Throws:

RemoteException

startBranch

void startBranch(ProcessInstance process,
                 String branchid)
          throws RemoteException

Start a branch. In a process where a branch is defined, this call start the branch. This can be done independent of the normal process flow.

Parameters:

process - process instance

branchid - the step-id of the branch step.

Throws:

RemoteException

addParforInstances

int addParforInstances(String stepid,
                       ActivityInstance previous)
                throws RemoteException

Start additional parfor branches for the given step. Branches are only started if there are already running branches.

Parameters:

stepid - the id of the parfor step

previous - an activity instance of the same process instance

Throws:

RemoteException

setOrgUnit

void setOrgUnit(ActivityInstance ai,
                OrgUnit d)
         throws RemoteException

Change the organizational unit of a process.

Parameters:

ai - an activity instance

d - the OrgUnit

Throws:

RemoteException

setDescription

void setDescription(ActivityInstance ai,
                    String descr)
             throws RemoteException

Set the description of an activity instance.

Parameters:

ai - an activity instance

descr - the new desription

Throws:

RemoteException

setSubject

void setSubject(ProcessInstance process)
         throws RemoteException

Set the subject of the process instance according to the definition in the process definition.

Parameters:

process - the process instance

Throws:

RemoteException

setSubjectToString

void setSubjectToString(ProcessInstance process,
                        String str)
                 throws RemoteException

Set the subject of the process instance o the given string value.

Parameters:

process - the process instance

str - the new subject

Throws:

RemoteException

updateForm

void updateForm(DMSForm f)
         throws RemoteException

Update the form (make the changes persistent).

Parameters:

f - the form

Throws:

RemoteException

setDuedate

void setDuedate(ActivityInstance ai,
                Date d)
         throws RemoteException

Set the duedate of the activity instance.

Parameters:

ai - an activity instance

d - the new due date

Throws:

RemoteException

setId

void setId(ProcessInstance pi,
           String s)
    throws RemoteException

Set the id of the process instance.

Parameters:

pi - a process instance

s - the new id

Throws:

RemoteException

setPriority

void setPriority(ProcessInstance pi,
                 int priority)
          throws RemoteException

Set the priority of the process instance.

Parameters:

pi - a process instance. The priority is set on the main process instance mpi of pi (and on subprocesses of mpi).

priority - the new priority, two digit integer, starting with 0 (means lowest priority).

Throws:

RemoteException

abort

void abort(ProcessInstance process)
    throws RemoteException

Abort a process.

Parameters:

process - the process instance. Should be a main Process, may be an ActivityInstance in a branch.

Throws:

RemoteException

reactivate

void reactivate(ProcessInstance process)
         throws RemoteException

Reactivate a process.

Parameters:

process - the process instance. Should be a main process.

Throws:

RemoteException

archive

void archive(ProcessInstance process)
      throws RemoteException

Archive a process. Remove it from the database.

Parameters:

process - the process instance

Throws:

RemoteException

checkAbort

void checkAbort(ProcessInstance process)
         throws RemoteException

Check if the thread user may abort the process. Either start agent and process in first step or edit process instance right.

Throws:

RemoteException

abort

void abort(ProcessInstance process,
           String comment)
    throws RemoteException

Abort a process and add a DMSNote with a generated Subject and a given comment.

Parameters:

process - the process instance. Should be a main Process, may be an ActivityInstance in a branch.

comment - a comment, why the process is aborted

Throws:

RemoteException

reactivate

void reactivate(ProcessInstance process,
                String comment)
         throws RemoteException

Reactivate a process.

Parameters:

process - the process instance. Should be a main Process.

comment - a comment, why the process is reactivated

Throws:

RemoteException

reactivateAndTake

void reactivateAndTake(ProcessInstance process,
                       String comment)
                throws RemoteException

Reactivate a process and take the reactivated tasks.

Parameters:

process - the process instance. Should be a main Process.

comment - a comment, why the process is reactivated

Throws:

RemoteException

getContext

ActivityInstance getContext()
                     throws RemoteException

Return the current activity instance. This method returns a non-null value when called from a postcondition, preprocessing, compensation method of a task of from a system step or a condition in a process definition.

Returns:

an activity instance

Throws:

RemoteException

setContext

void setContext(ActivityInstance ai)
         throws RemoteException

Throws:

RemoteException

getServerProperty

String getServerProperty(String prop)
                  throws RemoteException

Returns a property from the server

Returns:

the property, null if the property is unknown.

Throws:

RemoteException

listSuccessors

List<ActivityInstance> listSuccessors(ActivityInstance ai)
                               throws RemoteException

Return the list of successor steps of an activity instance.

Returns:

a list of activity instances

Throws:

RemoteException

listPredecessors

List<ActivityInstance> listPredecessors(ActivityInstance ai)
                                 throws RemoteException

Return the list of predecessor steps of an activity instance.

Returns:

a list of activity instances

Throws:

RemoteException

addAgent

void addAgent(ActivityInstance ai,
              Agent a,
              OrgUnit ou,
              DMSNote note)
       throws RemoteException

Add an agent which receives the process after the current agent

Parameters:

ai - the activity instance

a - a user or role

ou - an organizational unit, if null the ou of the previous activity instance is used

note - an (optional) note to the agent of the activity

Throws:

RemoteException

setCheckedOut

void setCheckedOut(ActivityInstance ai,
                   boolean state)
            throws RemoteException

Set the activityInstance as checcked out or in (i.e. is on mobile server)

Parameters:

state - if true we check it out

ai - the activity instance

Throws:

RemoteException

goBackToLastInteractive

void goBackToLastInteractive(ActivityInstance ai,
                             String comment)
                      throws RemoteException

Throws:

RemoteException

makeVersion

ActivityInstance makeVersion(ActivityInstance ai,
                             String desc,
                             boolean withDocs)
                      throws RemoteException

Versions the passed activity instance, the process forms and the documents (optional) and returns a new activity instance which is a copy of the passed one.

Parameters:

ai - the activity instance to version

desc - a comment for this version

withDocs - if true all the documents are also versioned

Returns:

the new activity instance

Throws:

RemoteException

refreshWLCacheOrgData

void refreshWLCacheOrgData()
                    throws RemoteException

Refresh the organizational data in the worklist cache.

Throws:

RemoteException

refreshWLCache

void refreshWLCache(User u)
             throws RemoteException

Refresh the organizational data in the WorklistCache for a particular user.

Parameters:

u - - the user

Throws:

RemoteException

setFinished

void setFinished(ActivityInstance ai)
          throws RemoteException

Set the status of the activity instance to FINISHED. This method should be used only in the expressions in an andjoin or end parfor node. In case of parfor set the state of the parent of the current activity instance. In both cases if you set the state to finished the engine will continue the process after the parallelism.

Parameters:

ai - the activity instance to be finished

Throws:

RemoteException

abortSiblings

void abortSiblings(ActivityInstance join)
            throws RemoteException

Abort the siblings of the par branch. The activity instance must be an instance of the andjoin node. Note that you must assure that the process continues after the andjoin, you can do this by calling wfEngine.setFinished(join) - otherwise the process will hang in the andjoin

Parameters:

join -

Throws:

RemoteException

abortParforSiblings

void abortParforSiblings(ActivityInstance parfor)
                  throws RemoteException

Abort the running siblings of the current parfor instances. Note that you must assure that the process continues after the parfor, you can do this by calling wfEngine.setFinished(parfor) - otherwise the process will hang in the end parfor node

Parameters:

parfor - an instance of the parfor step (a parent of an activityinstance inside the parfor)

Throws:

RemoteException

setSeen

void setSeen(ActivityInstance ai,
             boolean seen)
      throws RemoteException

Set the given ActivityInstance to seen/unseen for the current user.

Throws:

RemoteException

removeSeens

void removeSeens(ActivityInstance ai,
                 boolean meToo)
          throws RemoteException

Delete the seen information for the given ai.

Parameters:

ai - an activity instance

meToo - if true the seen information for the current user is also deleted.

Throws:

RemoteException

hasSeen

boolean hasSeen(ActivityInstance ai)
         throws RemoteException

Returns true if the ActivityInstance has been seen by the current user.

Throws:

RemoteException

getFormVersion

PersistentVersion getFormVersion(DMSForm form,
                                 ActivityInstance ai)
                          throws RemoteException

Returns the version of the passed form in the context of the passed activity instance.

Parameters:

form - the form which version is wanted

ai - the activity instance determining the context of the version

Returns:

the requested version or null if there is no such version

Throws:

RemoteException

listFormVersions

List<PersistentVersion> listFormVersions(ActivityInstance ai)
                                  throws RemoteException

Returns a list of form versions (at most one for each process form) which were made in the context of the passed activity instance.

Parameters:

ai - the activity instance determining the context of the versions

Returns:

the requested versions or an empty list if there are no such versions

Throws:

RemoteException

addSystemNote

void addSystemNote(ActivityInstance ai,
                   String subject,
                   String text)
            throws RemoteException

Attach a note to an ActivityInstance.

Parameters:

ai - the activity instance (or process instance) to which the note is attached

subject - the system note subject

text - the system note text

Throws:

RemoteException - Exception is thrown if the system note could not be created or attached to the given activity instance

propagateChange

void propagateChange(ActivityInstance ai)
              throws RemoteException

Inform the system that a change to an ActivityInstance has been made. Notifications will be sent to the clients.

This is only needed in special cases, when there were changes in some data that would lead to a different presentation of the ActivityInstance in a client and which where out of the scope of the automatic worklist change detection (e.g. redisplay a worklist item after some form update).

Parameters:

ai - the activity instance which has changed

Throws:

RemoteException

propagateProcessChange

void propagateProcessChange(ProcessInstance pi)
                     throws RemoteException

Inform the system that a process instance has been changed. Notifications for all active tasks of this process instance will be sent to the clients.

This is only needed in special cases, when there were changes in some data that would lead to different presentations in the worklists and which where out of the scope of the automatic worklist change detection (e.g. changes in displayed additional data).

Parameters:

pi - the process instance which has changed

Throws:

RemoteException

getUserFolders

List<UserFolder> getUserFolders()
                         throws RemoteException

Get the list of UserFolders of the current user.

Returns:

the list of UserFolders of the current user.

Throws:

RemoteException

mapToUserFolders

Map<ActivityInstance,UserFolder> mapToUserFolders(List<ActivityInstance> ais)
                                           throws RemoteException

Map a list of ActivityInstances to their corresponding UserFolders. If an ActivityInstance is in no UserFolder at all, it is not contained in the map.

Parameters:

ais - the list of activityInstances to be filtered

Returns:

the map of ActivityInstances to UserFolders

Throws:

RemoteException

filterByFolder

void filterByFolder(UserFolder uf,
                    List<ActivityInstance> ais)
             throws RemoteException

Filter a list of ActivityInstances. Keep those that are in the specified UserFolder. If the UserFolder is null, then all those ActivityInstances are kept in the list, that are in no UserFolder at all.

Parameters:

uf - the UserFolder to filter upon.

ais - the list of ActivityInstances to be filtered

Throws:

RemoteException