Skip navigation links

oracle.iam.platform.workflowservice.api
Interface WorkflowProvider

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

initiate

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

Create workfolw instance.

Parameters:

name - workflow process name

payloadID -

operationName -

serviceName -

payload - payload for the workflow instance

Returns:

provider specific ID for the created workflow instance

Throws:

IAMWorkflowException

cancel

void cancel(java.lang.String id)
            throws IAMWorkflowException

Cancel a workflow instance.

Parameters:

id - provider specific ID for the workflow instance.

Throws:

IAMWorkflowException

getState

java.lang.String getState(java.lang.String id)
                          throws IAMWorkflowException

Get the state for a workflow instance.

Parameters:

id - provider specific ID for the workflow instance

Returns:

state for the workflow instance

Throws:

InstanceException

IAMWorkflowException

getStatus

java.lang.String getStatus(java.lang.String id)
                           throws IAMWorkflowException

Get the status for a workflow instance.

Parameters:

id - provider specific ID for the workflow instance

Returns:

status for the workflow instance

Throws:

InstanceException

IAMWorkflowException

getApprovalTasks

ApprovalTask[] getApprovalTasks(java.lang.String identificationKey,
                                boolean onlyPendingTasks,
                                boolean onlyAssignedTasks)
                                throws IAMWorkflowException

Get the array of ApprovalTasks which are pending(state is assigned)

Parameters:

identificationKey -

onlyPending -

onlyAssignedTasks -

Returns:

Throws:

IAMWorkflowException

isApprovalTaskAssigned

boolean isApprovalTaskAssigned(java.lang.String identificationKey,
                               boolean onlyAssigned)
                               throws IAMWorkflowException

Check if task is assigned to a user

Parameters:

identificationKey -

onlyAssignedTasks -

Returns:

Throws:

IAMWorkflowException

withdraw

void withdraw(java.lang.String identificationKey)
              throws IAMWorkflowException

Withdraw a workflow instance of the given id. The identificationKey which uniquely identifies the instance to be withdrawn.

Parameters:

id - identificationKey which uniquely identifies the instance to be withdrawn.

Throws:

IAMWorkflowException

close

void close(java.lang.String identificationKey)
           throws IAMWorkflowException

Throws:

IAMWorkflowException

Skip navigation links