|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WfProcess
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.
Method Summary | |
---|---|
WfActivityIterator |
get_activities_in_state(java.lang.String state)
This operation is used to get an iterator over WfActivity objects that are in a certain state. |
WfActivityIterator |
get_iterator_step()
Zero or more WfActivities are associated with a WfProcess. |
WfActivity[] |
get_sequence_step(int max_number)
Zero or more WfActivities are associated with a WfProcess. |
int |
how_many_step()
Zero or more WfActivities are associated with a WfProcess. |
boolean |
is_member_of_step(WfActivity member)
Zero or more WfActivities are associated with a WfProcess. |
WfProcessMgr |
manager()
A process is associated with one WfProcessMgr; the association is established when the WfProcess is generated and cannot be modified. |
WfRequester |
requester()
A WfProcess is created (using a WfProcessMgr) by a user or automated resource and associated with a WfRequester. |
java.util.Map |
result()
The result produced by the WfProcess. |
void |
set_requester(WfRequester new_value)
A WfProcess is created (using a WfProcessMgr) by a user or automated resource and associated with a WfRequester. |
void |
start()
This operation is used to initiate enactment of a WfProcess. |
Methods inherited from interface org.enhydra.shark.api.client.wfmodel.WfExecutionObject |
---|
abort, change_state, description, get_iterator_history, get_sequence_history, how_closed, how_many_history, is_member_of_history, key, last_state_time, name, priority, process_context, resume, set_description, set_name, set_priority, set_process_context, state, suspend, terminate, valid_states, while_open, why_not_running, workflow_state |
Method Detail |
---|
WfRequester requester() throws java.lang.Exception
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.
java.lang.Exception
void set_requester(WfRequester new_value) throws java.lang.Exception, CannotChangeRequester
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.
java.lang.Exception
CannotChangeRequester
int how_many_step() throws java.lang.Exception
The following operation provide the information about the number of active WfActivity items currently associated with a WfProcess.
java.lang.Exception
WfActivityIterator get_iterator_step() throws java.lang.Exception
The following operation returns iterator for qurying associated activities based on some criteria.
java.lang.Exception
WfActivity[] get_sequence_step(int max_number) throws java.lang.Exception
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.
java.lang.Exception
boolean is_member_of_step(WfActivity member) throws java.lang.Exception
The following operation returns true if given activity is associated with WfProcess.
java.lang.Exception
WfProcessMgr manager() throws java.lang.Exception
java.lang.Exception
java.util.Map result() throws java.lang.Exception, ResultNotAvailable
java.lang.Exception
ResultNotAvailable
void start() throws java.lang.Exception, CannotStart, AlreadyRunning
CannotStart
- raised when the process cannot be started (e.g., because it is
not properly initialized).
AlreadyRunning
- raised when the process has already been started.
java.lang.Exception
WfActivityIterator get_activities_in_state(java.lang.String state) throws java.lang.Exception, InvalidState
java.lang.Exception
InvalidState
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |