|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkflowService
This is the main interface for using the workflowservice. It has couple of uses 1. Manage the workflow definitions in OIM Operations include Create,delete and list definitions 2. Manage workflow instances in OIM Operations include initiate,cancel,query status of particular workflow instance The workflow categories are next level abstractions which define which category a given workflow falls under. e.g of categories are approval, attestation etc. The category is static metadata and is obtained using xml files defined under a particular feature.
Method Summary | |
---|---|
void |
cancel(java.lang.String id) Cancel a workflow instance. |
void |
close(java.lang.String identificationKey) close a workflow instance of the given id. |
boolean |
disableWorkflowDefinition(java.lang.String name) Disable a particular definition from OIM DB. |
void |
enableWorkFlowDefinition(java.lang.String workflowDefinition) Re-Register workflow definition which already exists in OIM DB and enable it if disabled. |
java.util.List |
getAllWorkflowDefinitions() Get the list of all registered workflow definitions. |
ApprovalTask[] |
getApprovalTasks(java.lang.String identificationKey, boolean onlyPending) Gets Approval Tasks from the underlying provider |
ApprovalTask[] |
getApprovalTasks(java.lang.String identificationKey, boolean onlyPending, boolean onlyAssigned) Gets Approval Tasks from the underlying provider |
java.lang.String |
getState(java.lang.String id) Gets the state a workflow instance. |
java.lang.String |
getStatus(java.lang.String id) Gets the status a workflow instance. |
java.util.Map |
getWFCategories() To get all the workflow categories for OIM |
WorkflowDefinition |
getWorkflowDefinition(java.lang.String name) Get the registered workflow definition with given name. |
java.util.List |
getWorkflowDefinitions(java.lang.String category) Get the list of all registered workflow definitions with given workflow category. |
java.util.List |
getWorkflowDefinitions(java.lang.String type, java.lang.String pattern) To get all workflow composites in specific category with a specific pattern |
java.lang.String |
initiate(java.lang.String name, java.lang.String inputXML) Initiate workflow with given name and payload. |
boolean |
isApprovalTaskAssigned(java.lang.String identificationKey, boolean onlyAssigned) Determine if logged-in user has any task assigned |
void |
registerWFDefinitionNoMapping(WorkflowDefinition workflowDefinition) Register workflow definition in OIM DB without creating any mapping (apps requirement). |
void |
registerWorkFlowDefinition(WorkflowDefinition workflowDefinition) Register workflow definition to OIM DB. |
void |
withdraw(java.lang.String identificationKey) Withdraw a workflow instance of the given id. |
Method Detail |
---|
void registerWorkFlowDefinition(WorkflowDefinition workflowDefinition) throws IAMWorkflowException
workflowDefinition
-IAMWorkflowException
void enableWorkFlowDefinition(java.lang.String workflowDefinition) throws IAMWorkflowException
workflowDefinition
-IAMWorkflowException
void registerWFDefinitionNoMapping(WorkflowDefinition workflowDefinition) throws IAMWorkflowException
workflowDefinition
-IAMWorkflowException
java.util.List getWorkflowDefinitions(java.lang.String category)
type
- workflow typeWorkflowDefinition getWorkflowDefinition(java.lang.String name) throws IAMWorkflowException
name
- workflow nameIAMWorkflowException
java.util.List getAllWorkflowDefinitions()
java.lang.String initiate(java.lang.String name, java.lang.String inputXML) throws IAMWorkflowException
name
- workflow definition namepayload
- payload for the workflow instanceInstanceCreationException
IAMWorkflowException
void cancel(java.lang.String id) throws IAMWorkflowException
id
- workflow instance IDIAMWorkflowException
java.lang.String getState(java.lang.String id) throws IAMWorkflowException
id
- workflow instance IDIAMWorkflowException
java.lang.String getStatus(java.lang.String id) throws IAMWorkflowException
id
- workflow instance IDIAMWorkflowException
boolean disableWorkflowDefinition(java.lang.String name) throws IAMWorkflowException
name
- -- definition nameIAMWorkflowException
ApprovalTask[] getApprovalTasks(java.lang.String identificationKey, boolean onlyPending) throws IAMWorkflowException
identificationKey
-onlyPending
- if set to true, API returns only pending Tasks (both rfi and assigned), if set to false API returns all Approval TasksIAMWorkflowException
ApprovalTask[] getApprovalTasks(java.lang.String identificationKey, boolean onlyPending, boolean onlyAssigned) throws IAMWorkflowException
identificationKey
-onlyPending
- if set to true, API returns only pending Approval Tasks, if set to false API returns all Approval TasksonlyAssigned
- if set to true, it returns only Assigned tasksIAMWorkflowException
java.util.Map getWFCategories()
java.util.List getWorkflowDefinitions(java.lang.String type, java.lang.String pattern) throws IAMWorkflowException
type
-pattern
-IAMWorkflowException
boolean isApprovalTaskAssigned(java.lang.String identificationKey, boolean onlyAssigned) throws IAMWorkflowException
identificationKey
-onlyAssigned
- if set to true, it checks only Assigned tasks, else it checks for Assigned as well as Request for Information tasksIAMWorkflowException
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
id
- identificationKey which uniquely identifies the instance to be close.IAMWorkflowException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |