| org.enhydra.shark.api.client.wfmodel.WfProcess
All known Subclasses: org.enhydra.shark.ejb.WfProcessSSBean, org.enhydra.shark.WfProcessWrapper,
| WfProcess | | public interface WfProcess extends WfExecutionObject(Code) | | OMG definition: A WfProcess is the performer of a workflow request. All workflow
objects that perform work implement this interface. This interface allows work to
proceed asynchronously while being monitored and controlled. The WfProcess interface
specializes WfExecutionObject interface by adding an operation to start the execution
of the process, an operation to obtain the result produced by the process and
relationships with WfRequester and WfActivity.
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.
|
| get_activities_in_state | | WfActivityIterator get_activities_in_state(String state) throws Exception, InvalidState(Code) | | This operation is used to get an iterator over WfActivity objects that are in a
certain state. The state is an input parameter. In case an invalid state has been
specified, the exception InvalidState is raised.
|
| get_iterator_step | | WfActivityIterator get_iterator_step() throws Exception(Code) | | Zero or more WfActivities are associated with a WfProcess. The association is
established when an activity is created as part of the enactment of the WfProcess.
The following operation returns iterator for qurying associated activities based on
some criteria.
|
| get_sequence_step | | WfActivity[] get_sequence_step(int max_number) throws Exception(Code) | | Zero or more WfActivities are associated with a WfProcess. The association is
established when an activity is created as part of the enactment of the WfProcess.
The following operation returns max_number of WfActivity objects associated with an
WfProcess (no matter in which state they are). If max_number is less or eaqual to
zero, or it is greater than the number of existing activities, all associated
WfActivity objects will be returned.
|
| how_many_step | | int how_many_step() throws Exception(Code) | | Zero or more WfActivities are associated with a WfProcess. The association is
established when an activity is created as part of the enactment of the WfProcess.
The following operation provide the information about the number of active
WfActivity items currently associated with a WfProcess.
|
| is_member_of_step | | boolean is_member_of_step(WfActivity member) throws Exception(Code) | | Zero or more WfActivities are associated with a WfProcess. The association is
established when an activity is created as part of the enactment of the WfProcess.
The following operation returns true if given activity is associated with WfProcess.
|
| manager | | WfProcessMgr manager() throws Exception(Code) | | A process is associated with one WfProcessMgr; the association is established when
the WfProcess is generated and cannot be modified. The following operation returns
the WfProcessMgr associated with the WfProcess.
|
| requester | | WfRequester requester() throws Exception(Code) | | A WfProcess is created (using a WfProcessMgr) by a user or automated resource and
associated with a WfRequester. The WfRequester may be a WfActivity or an adapter for
external clients. WfProcess always has one WfRequester; an implementation of the WfM
Facility may allow for re-assignment of the WfRequester associated with a WfProcess.
A WfProcess will inform its WfRequester about status changes such as modification of
its state and its context using the requesters receive_event operation.
The following operation returns the requester.
|
| result | | Map result() throws Exception, ResultNotAvailable(Code) | | The result produced by the WfProcess. In general the result is undefined until the
process completes, but some processes may produce intermediate results. A
ResultNotAvailable exception is raised when the result cannot be obtained yet.
|
| set_requester | | void set_requester(WfRequester new_value) throws Exception, CannotChangeRequester(Code) | | A WfProcess is created (using a WfProcessMgr) by a user or automated resource and
associated with a WfRequester. The WfRequester may be a WfActivity or an adapter for
external clients. WfProcess always has one WfRequester; an implementation of the WfM
Facility may allow for re-assignment of the WfRequester associated with a WfProcess.
A WfProcess will inform its WfRequester about status changes such as modification of
its state and its context using the requesters receive_event operation.
The following operations changes the process requester.
|
| start | | void start() throws Exception, CannotStart, AlreadyRunning(Code) | | This operation is used to initiate enactment of a WfProcess. The state of the
process is changed from open.not_running.not_started to open.running.
throws:
CannotStart - raised when the process cannot be started (e.g., because it isnot properly initialized).
throws:
AlreadyRunning - raised when the process has already been started.
throws:
Exception - |
|
|