de.danet.an.workflow.omgcore
Interface WfProcessMgr

All Superinterfaces:

WfObject

All Known Subinterfaces:

ProcessMgr

public interface WfProcessMgr

extends WfObject

A WfProcessMgr represents a template for a specific workflow process; it is used to create instances of a workflow process. Logically it is the factory and locator for WfProcess instances.

Field Summary

static int	DISABLED Indicates that creation of workflow processes is disabled.
static int	ENABLED Indicates that creation of workflow processes is enabled.

Method Summary

java.lang.String	category() Return the category of a process manager used for classification of process types.
ProcessDataInfo	contextSignature() Returns the meta information that defines how to set the context of an instance.
WfProcess	createProcess(WfRequester requester) Create instances of a process and link its requester.
java.lang.String	description() Returns the description of the process manager.
java.lang.String	name() Returns the name of the process manager.
java.util.Collection	processes() Returns a collection with WfProcess objects from this process manager.
int	processMgrState() Returns the state of the WfProcessMgr.
ProcessDataInfo	resultSignature() Returns the meta information that specifies how instances will return results.
void	setProcessMgrState(int newState) Set the new state of this process manager.
java.lang.String	version() Return the version attribute of a process manager used to distinguish between different versions of a process model.

Field Detail

DISABLED

public static final int DISABLED

Indicates that creation of workflow processes is disabled.

See Also:

Constant Field Values

ENABLED

public static final int ENABLED

Indicates that creation of workflow processes is enabled.

See Also:

Constant Field Values

Method Detail

processes

public java.util.Collection processes()
                               throws java.rmi.RemoteException

Returns a collection with WfProcess objects from this process manager.

Returns:

a Collection object of WfProcess.

Throws:

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

processMgrState

public int processMgrState()
                    throws java.rmi.RemoteException

Returns the state of the WfProcessMgr.

Returns:

WfProcessMgr.ENABLED if creation of workflow processes is enabled, otherwise WfProcessMgr.DISABLED.

Throws:

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

setProcessMgrState

public void setProcessMgrState(int newState)
                        throws java.rmi.RemoteException,
                               TransitionNotAllowedException

Set the new state of this process manager.

Parameters:

newState - the new state.

Throws:

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

TransitionNotAllowedException - if the transition is not allowed

name

public java.lang.String name()
                      throws java.rmi.RemoteException

Returns the name of the process manager.

Returns:

the name.

Throws:

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

description

public java.lang.String description()
                             throws java.rmi.RemoteException

Returns the description of the process manager.

Returns:

the description.

Throws:

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

category

public java.lang.String category()
                          throws java.rmi.RemoteException

Return the category of a process manager used for classification of process types. It is set when the process manager is initialized and cannot be modified.

Returns:

the string of category.

Throws:

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

version

public java.lang.String version()
                         throws java.rmi.RemoteException

Return the version attribute of a process manager used to distinguish between different versions of a process model.

Returns:

the version.

Throws:

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

contextSignature

public ProcessDataInfo contextSignature()
                                 throws java.rmi.RemoteException

Returns the meta information that defines how to set the context of an instance.

Returns:

the process meta information.

Throws:

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

resultSignature

public ProcessDataInfo resultSignature()
                                throws java.rmi.RemoteException

Returns the meta information that specifies how instances will return results.

Returns:

the process meta information.

Throws:

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

createProcess

public WfProcess createProcess(WfRequester requester)
                        throws java.rmi.RemoteException,
                               NotEnabledException,
                               InvalidRequesterException,
                               RequesterRequiredException

Create instances of a process and link its requester.

Parameters:

requester - the requester to create process.

Returns:

the created process.

Throws:

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

NotEnabledException - when the process manager is disabled.

InvalidRequesterException - when the process definition requires a WfRequester and an invalid WfRequester is supplied in the parameter.

RequesterRequiredException - when a WfRequester is being identified that cannot be a parent of instances of the process.