|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkflowProvider
Workflow Provider is internally used by the WorkflowService
to interact with the Workflow Service Engine. For each Workflow Engine that needs to be used, a new provider needs to be implemented and registered to OIM DB using WorkflowProviderManager
Method Summary | |
---|---|
void |
cancel(java.lang.String id) Cancel a workflow instance. |
void |
close(java.lang.String identificationKey) |
ApprovalTask[] |
getApprovalTasks(java.lang.String identificationKey, boolean onlyPendingTasks, boolean onlyAssignedTasks) Get the array of ApprovalTasks which are pending(state is assigned) |
java.lang.String |
getState(java.lang.String id) Get the state for a workflow instance. |
java.lang.String |
getStatus(java.lang.String id) Get the status for a workflow instance. |
java.lang.String |
initiate(java.lang.String inputXML, java.lang.String name, java.lang.String serviceName, java.lang.String operationName, java.lang.String payloadID) Create workfolw instance. |
boolean |
isApprovalTaskAssigned(java.lang.String identificationKey, boolean onlyAssigned) Check if task is assigned to a user |
void |
withdraw(java.lang.String identificationKey) Withdraw a workflow instance of the given id. |
Method Detail |
---|
java.lang.String initiate(java.lang.String inputXML, java.lang.String name, java.lang.String serviceName, java.lang.String operationName, java.lang.String payloadID) throws IAMWorkflowException
name
- workflow process namepayloadID
-operationName
-serviceName
-payload
- payload for the workflow instanceIAMWorkflowException
void cancel(java.lang.String id) throws IAMWorkflowException
id
- provider specific ID for the workflow instance.IAMWorkflowException
java.lang.String getState(java.lang.String id) throws IAMWorkflowException
id
- provider specific ID for the workflow instanceInstanceException
IAMWorkflowException
java.lang.String getStatus(java.lang.String id) throws IAMWorkflowException
id
- provider specific ID for the workflow instanceInstanceException
IAMWorkflowException
ApprovalTask[] getApprovalTasks(java.lang.String identificationKey, boolean onlyPendingTasks, boolean onlyAssignedTasks) throws IAMWorkflowException
identificationKey
-onlyPending
-onlyAssignedTasks
-IAMWorkflowException
boolean isApprovalTaskAssigned(java.lang.String identificationKey, boolean onlyAssigned) throws IAMWorkflowException
identificationKey
-onlyAssignedTasks
-IAMWorkflowException
void withdraw(java.lang.String identificationKey) throws IAMWorkflowException
id
- identificationKey which uniquely identifies the instance to be withdrawn.IAMWorkflowException
void close(java.lang.String identificationKey) throws IAMWorkflowException
IAMWorkflowException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |