Skip navigation links


oracle.iam.platformservice.api
Interface WorkflowRegistrationService


public interface WorkflowRegistrationService

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
 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.
 java.util.List getWorkflowDefinitions(java.lang.String type, java.lang.String pattern)
          To get all workflow composites in specific category with a specific pattern
 void registerWFDefinitionNoMapping(oracle.iam.platform.workflowservice.vo.WorkflowDefinition workflowDefinition)
          Register workflow definition in OIM DB without creating any mapping (apps requirement).
 void registerWorkFlowDefinition(oracle.iam.platform.workflowservice.vo.WorkflowDefinition workflowDefinition)
          Register workflow definition to OIM DB.

 

Method Detail

registerWorkFlowDefinition

void registerWorkFlowDefinition(oracle.iam.platform.workflowservice.vo.WorkflowDefinition workflowDefinition)
                                throws oracle.iam.platform.workflowservice.exception.IAMWorkflowException
Register workflow definition to OIM DB. This registers a given workflow process, and hence should be done before intiation of the process.
Parameters:
workflowDefinition -
Throws:
oracle.iam.platform.workflowservice.exception.IAMWorkflowException

disableWorkflowDefinition

boolean disableWorkflowDefinition(java.lang.String name)
                                  throws oracle.iam.platform.workflowservice.exception.IAMWorkflowException
Disable a particular definition from OIM DB.
Parameters:
name - -- definition name
Throws:
oracle.iam.platform.workflowservice.exception.IAMWorkflowException

getAllWorkflowDefinitions

java.util.List getAllWorkflowDefinitions()
Get the list of all registered workflow definitions. ALl definitions of all categories is returned
Returns:
list of all registered workflow definitions

enableWorkFlowDefinition

void enableWorkFlowDefinition(java.lang.String workflowDefinition)
                              throws oracle.iam.platform.workflowservice.exception.IAMWorkflowException
Re-Register workflow definition which already exists in OIM DB and enable it if disabled. This registers a given workflow process, and hence should be done before intiation of the process.
Parameters:
workflowDefinition -
Throws:
oracle.iam.platform.workflowservice.exception.IAMWorkflowException

registerWFDefinitionNoMapping

void registerWFDefinitionNoMapping(oracle.iam.platform.workflowservice.vo.WorkflowDefinition workflowDefinition)
                                   throws oracle.iam.platform.workflowservice.exception.IAMWorkflowException
Register workflow definition in OIM DB without creating any mapping (apps requirement). This registers a given workflow process, and hence should be done before intiation of the process.
Parameters:
workflowDefinition -
Throws:
oracle.iam.platform.workflowservice.exception.IAMWorkflowException

getWorkflowDefinitions

java.util.List getWorkflowDefinitions(java.lang.String type,
                                      java.lang.String pattern)
                                      throws oracle.iam.platform.workflowservice.exception.IAMWorkflowException
To get all workflow composites in specific category with a specific pattern
Parameters:
type -
pattern -
Throws:
oracle.iam.platform.workflowservice.exception.IAMWorkflowException

Skip navigation links


Copyright © 2011, Oracle and/or its affiliates. All rights reserved.