|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WfActivity
OMG definition:WfActivity is a step in a process that is associated, as part of an aggregation, with a single WfProcess. It represents a request for work in the context of the containing WfProcess. There can be many active WfActivity objects within a WfProcess at a given point in time. The WfActivity interface specializes WfExecutionObject with an explicit complete operation to signal completion of the step, and with an operation to set the result of the WfActivity. It also adds relationships with WfProcess and WfAssignment.
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 | |
---|---|
void |
complete()
This operation is used by an application to signal completion of the WfActivity. |
WfProcess |
container()
This operation returns the WfProcess that this activity is a part of. |
WfAssignmentIterator |
get_iterator_assignment()
Zero or more WfAssignments can be associated with a WfActivity. |
WfAssignment[] |
get_sequence_assignment(int max_number)
Zero or more WfAssignments can be associated with a WfActivity. |
int |
how_many_assignment()
Zero or more WfAssignments can be associated with a WfActivity. |
boolean |
is_member_of_assignment(WfAssignment member)
Zero or more WfAssignments can be associated with a WfActivity. |
java.util.Map |
result()
Represents the result produced by the realization of the work request represented by an activity. |
void |
set_result(java.util.Map result)
The set_result operation is used to pass process data back to the workflow process. |
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 |
Methods inherited from interface org.enhydra.shark.api.client.wfmodel.WfRequester |
---|
get_iterator_performer, get_sequence_performer, how_many_performer, is_member_of_performer, receive_event |
Method Detail |
---|
int how_many_assignment() throws java.lang.Exception
The following operation returns the number of WfAssignments associated with an activity.
java.lang.Exception
WfAssignmentIterator get_iterator_assignment() throws java.lang.Exception
The following operation returns iterator for qurying associated assignments based on some criteria.
java.lang.Exception
WfAssignment[] get_sequence_assignment(int max_number) throws java.lang.Exception
The following operation returns max_number of WfAssignment objects associated with an activity. If max_number is less or eaqual to zero, or it is greater than the number of existing assignments, all associated WfAssignments objects will be returned.
java.lang.Exception
boolean is_member_of_assignment(WfAssignment member) throws java.lang.Exception
The following operation returns true if given assignment is associated with activity.
java.lang.Exception
WfProcess container() throws java.lang.Exception
java.lang.Exception
java.util.Map result() throws java.lang.Exception, ResultNotAvailable
java.lang.Exception
ResultNotAvailable
void set_result(java.util.Map result) throws java.lang.Exception, InvalidData
java.lang.Exception
InvalidData
void complete() throws java.lang.Exception, CannotComplete
java.lang.Exception
CannotComplete
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |