de.danet.an.workflow.api
Interface Process

All Superinterfaces:

ExecutionObject, java.io.Serializable, WfExecutionObject, WfObject, WfProcess

public interface Process

extends ExecutionObject, WfProcess

Interface Process adds some functions to the OMG process.

Nested Class Summary

Nested classes inherited from class de.danet.an.workflow.omgcore.WfExecutionObject

WfExecutionObject.ClosedState, WfExecutionObject.NotRunningState, WfExecutionObject.OpenState, WfExecutionObject.State

Method Summary

Activity	activityByKey(java.lang.String key) Returns the Activity with the given key.
java.util.Date	createTime() Returns the creation time of the process.
ProcessDefinition	processDefinition() Returns the process definition of this process.
void	setDebugEnabled(boolean debug) Enable or disable debugging of the process.
java.util.List	transitions() Gets a list of transitions for this process.

Methods inherited from interface de.danet.an.workflow.api.ExecutionObject

changeState, debugEnabled, typedState

Methods inherited from interface de.danet.an.workflow.omgcore.WfExecutionObject

abort, changeState, description, history, howClosed, key, lastStateTime, name, priority, processContext, resume, setDescription, setName, setPriority, setProcessContext, state, suspend, terminate, validStates, whileOpen, whyNotRunning, workflowState

Methods inherited from interface de.danet.an.workflow.omgcore.WfProcess

activitiesInState, manager, requester, result, setRequester, start, steps

Method Detail

activityByKey

public Activity activityByKey(java.lang.String key)
                       throws java.rmi.RemoteException,
                              InvalidKeyException

Returns the Activity with the given key. The OMG interface only defines a method for listing all the activities associated with the process. While, of course, one could select the activity with a certain key from that list, this would be rather insufficient.

Parameters:

key - the key of the activity

Returns:

the activity associated with the key

Throws:

InvalidKeyException - if no activity with the given key exists

java.rmi.RemoteException - if a system-level error occurs.

processDefinition

public ProcessDefinition processDefinition()
                                    throws java.rmi.RemoteException

Returns the process definition of this process.

Returns:

the representation of the process definition.

Throws:

java.rmi.RemoteException - if a system-level error occurs.

transitions

public java.util.List transitions()
                           throws java.rmi.RemoteException

Gets a list of transitions for this process.

Returns:

list of transitions for this process

Throws:

java.rmi.RemoteException - if a system level error occurs.

createTime

public java.util.Date createTime()
                          throws java.rmi.RemoteException

Returns the creation time of the process.

Returns:

the creation time.

Throws:

java.rmi.RemoteException - if a system-level error occurs.

setDebugEnabled

public void setDebugEnabled(boolean debug)
                     throws java.rmi.RemoteException,
                            InvalidStateException

Enable or disable debugging of the process. Changing the debug mode is only allowed when the process has been started.

Parameters:

debug - if the process is to be debugged

Throws:

java.rmi.RemoteException - if a system-level error occurs.

InvalidStateException - if changing the debug mode is not allowed