|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WfProcessMgr
OMG definition: 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. It provides access to the meta information about the context a process requires and the result a process produces. A process manager is identified by its name which is unique within a given business domain. It could located, for example, via name using the OMG Naming Service, via name and other attributes (e.g., category) via the OMG Trader Service, or other infrastructure mechanisms.
We extended OMG's interface by duplicating methods, and adding additional parameter that represents transaction. If you use methods without SharkTransaction parameter, the transaction will be implicitly created, and if you use it with SharkTransaction parameter you must obey to some rules explained in HowTo documentation.
Method Summary | |
---|---|
java.lang.String |
category()
The category of a process manager is used for classification of process types. |
java.util.Map |
context_signature()
Meta information that defines how to set the context of an instance of this interface is returned by this operation. |
WfProcess |
create_process(WfRequester requester)
This operation is used to create instances of a process model and link its requester. |
java.lang.String |
description()
Returns description of the process manager. |
WfProcessIterator |
get_iterator_process()
Zero or more WfProcesses are associated with the WfProcessMgr that was used to create them. |
WfProcess[] |
get_sequence_process(int max_number)
Zero or more WfProcesses are associated with the WfProcessMgr that was used to create them. |
int |
how_many_process()
Zero or more WfProcesses are associated with the WfProcessMgr that was used to create them. |
boolean |
is_member_of_process(WfProcess member)
Zero or more WfProcesses are associated with the WfProcessMgr that was used to create them. |
java.lang.String |
name()
Returns the name of the process manager. |
process_mgr_stateType |
process_mgr_state()
A WfProcessMgr can be enabled or disabled. |
java.util.Map |
result_signature()
Meta information that defines how to return the result of an instance of this interface is returned by this operation. |
void |
set_process_mgr_state(process_mgr_stateType new_state)
A WfProcessMgr can be enabled or disabled. |
java.lang.String |
version()
The version attribute of a process manager is used to distinguish between different versions of a process model. |
Method Detail |
---|
int how_many_process() throws java.lang.Exception
The following operation provide the information about the number of WfProcess items associated with a WfProcessMgr.
java.lang.Exception
WfProcessIterator get_iterator_process() throws java.lang.Exception
The following operation returns iterator for qurying associated processes based on some criteria.
java.lang.Exception
WfProcess[] get_sequence_process(int max_number) throws java.lang.Exception
The following operation returns max_number of WfProcess objects associated with an WfProcessMgr. If max_number is less or eaqual to zero, or it is greater than the number of existing processes, all associated WfProcess objects will be returned.
java.lang.Exception
boolean is_member_of_process(WfProcess member) throws java.lang.Exception
The following operation returns true if given process is associated with WfProcessMgr.
java.lang.Exception
process_mgr_stateType process_mgr_state() throws java.lang.Exception
java.lang.Exception
void set_process_mgr_state(process_mgr_stateType new_state) throws java.lang.Exception, TransitionNotAllowed
java.lang.Exception
TransitionNotAllowed
java.lang.String name() throws java.lang.Exception
java.lang.Exception
java.lang.String description() throws java.lang.Exception
java.lang.Exception
java.lang.String category() throws java.lang.Exception
java.lang.Exception
java.lang.String version() throws java.lang.Exception
java.lang.Exception
java.util.Map context_signature() throws java.lang.Exception
The Map entry identifies the name and the data type (represented by its string name) of the data item. Map contains an entry for each data item in the set of context.
java.lang.Exception
java.util.Map result_signature() throws java.lang.Exception
The Map entry identifies the name and the data type (represented by its string name) of the data item. Map contains an entry for each data item in the set of result data for the WfProcess.
java.lang.Exception
WfProcess create_process(WfRequester requester) throws java.lang.Exception, NotEnabled, InvalidRequester, RequesterRequired
It is up to the implementation of the WfM Facility to decide which WfRequester objects to accept or not. When a WfRequester is rejected, the invoking application might decide not to register a WfRequester with the WfProcess.
requester
- a WfRequester
java.lang.Exception
NotEnabled
- raised when the process manager is disabled.
InvalidRequester
- raised when a WfRequester is being identified that cannot
be a 'parent' of instances of the process model.
RequesterRequired
- raised when the process definition requires a WfRequester
and an invalid WfRequester is supplied in the parameter.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |