com.ibm.pim.workflow
Interface WorkflowManager

All Superinterfaces:
Manager

public interface WorkflowManager
extends Manager

WorkflowManager is an Interface for the manager of Workflow objects. Use this class to create and retrieve Workflow objects.

Since:
6.0.0

Field Summary
 
Fields inherited from interface com.ibm.pim.common.Manager
copyright
 
Method Summary
 Workflow createCategoryWorkflow(java.lang.String workflowName, java.lang.String workflowDescription)
          Create an empty Category Workflow with Initial, Success, Failure steps and Initial routed to Success.
 Workflow createCategoryWorkflow(java.lang.String workflowName, java.lang.String workflowDescription, AccessControlGroup acg)
          Create an empty Category Workflow with Initial, Success, Failure steps and Initial routed to Success.
 Workflow createItemWorkflow(java.lang.String workflowName, java.lang.String workflowDescription)
          Create an empty Item Workflow with Initial, Success, Failure steps and Initial routed to Success.
 Workflow createItemWorkflow(java.lang.String workflowName, java.lang.String workflowDescription, AccessControlGroup acg)
          Create an empty Item Workflow with Initial, Success, Failure steps and Initial routed to Success.
 Workflow getWorkflow(java.lang.String workflowName)
          Retrieve a workflow by name
 java.util.Collection<Workflow> getWorkflows()
          Retrieve all Workflows available in the current context (ie those Workflows which the current user/role is allowed to administrate).
 
Methods inherited from interface com.ibm.pim.common.Manager
getManagerName
 

Method Detail

createItemWorkflow

Workflow createItemWorkflow(java.lang.String workflowName,
                            java.lang.String workflowDescription,
                            AccessControlGroup acg)
Create an empty Item Workflow with Initial, Success, Failure steps and Initial routed to Success.

Parameters:
workflowName - the name for the new workflow
workflowDescription - the description for the new workflow
acg - the access control group for the new workflow
Returns:
the new Workflow
Throws:
PIMInternalException - If an internal error occurs
java.lang.IllegalArgumentException - If null or empty String/AccessControlGroup is passed
PIMAuthorizationException - Reserved for future use

createCategoryWorkflow

Workflow createCategoryWorkflow(java.lang.String workflowName,
                                java.lang.String workflowDescription,
                                AccessControlGroup acg)
Create an empty Category Workflow with Initial, Success, Failure steps and Initial routed to Success.

Parameters:
workflowName - the name for the new workflow
workflowDescription - the description for the new workflow
acg - the access control group for the new workflow
Returns:
the new Workflow
Throws:
java.lang.IllegalArgumentException - If null or empty String/AccessControlGroup is passed
PIMAuthorizationException - Reserved for future use

createItemWorkflow

Workflow createItemWorkflow(java.lang.String workflowName,
                            java.lang.String workflowDescription)
Create an empty Item Workflow with Initial, Success, Failure steps and Initial routed to Success. The default AccessControlGroup will be used.

Parameters:
workflowName - the name for the new workflow
workflowDescription - the description for the new workflow
Returns:
the new Workflow
Throws:
PIMInternalException - If an internal error occurs
java.lang.IllegalArgumentException - If null or empty String is passed
PIMAuthorizationException - Reserved for future use

createCategoryWorkflow

Workflow createCategoryWorkflow(java.lang.String workflowName,
                                java.lang.String workflowDescription)
Create an empty Category Workflow with Initial, Success, Failure steps and Initial routed to Success. The default AccessControlGroup will be used.

Parameters:
workflowName - the name for the new workflow
workflowDescription - the description for the new workflow
Returns:
the new Workflow
Throws:
PIMInternalException - If an internal error occurs
java.lang.IllegalArgumentException - If null or empty String is passed
PIMAuthorizationException - Reserved for future use

getWorkflows

java.util.Collection<Workflow> getWorkflows()
Retrieve all Workflows available in the current context (ie those Workflows which the current user/role is allowed to administrate). If none are available, an empty Collection will be returned.
PIMAuthorization exception is not thrown since access check is used to filter the returned workflows. If user is not authorized to access any workflow, an empty collection will be returned.

Returns:
A Collection of Workflows
Throws:
PIMInternalException - If an internal error occurs

getWorkflow

Workflow getWorkflow(java.lang.String workflowName)
Retrieve a workflow by name

Parameters:
workflowName - the name of the workflow to be retrieved
Returns:
the workflow with the specified name, or null if none exists
Throws:
PIMInternalException - If an internal error occurs
java.lang.IllegalArgumentException - If null or empty String is passed
PIMAuthorizationException - If the user does not have the equivalent of Permission.WORKFLOW_LIST