|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkflowManager
WorkflowManager is an Interface for the manager of Workflow objects. Use this class to create and retrieve Workflow objects.
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 |
---|
Workflow createItemWorkflow(java.lang.String workflowName, java.lang.String workflowDescription, AccessControlGroup acg)
workflowName
- the name for the new workflowworkflowDescription
- the description for the new workflowacg
- the access control group for the new workflow
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null or empty String/AccessControlGroup is passed
PIMAuthorizationException
- Reserved for future useWorkflow createCategoryWorkflow(java.lang.String workflowName, java.lang.String workflowDescription, AccessControlGroup acg)
workflowName
- the name for the new workflowworkflowDescription
- the description for the new workflowacg
- the access control group for the new workflow
java.lang.IllegalArgumentException
- If null or empty String/AccessControlGroup is passed
PIMAuthorizationException
- Reserved for future useWorkflow createItemWorkflow(java.lang.String workflowName, java.lang.String workflowDescription)
workflowName
- the name for the new workflowworkflowDescription
- the description for the new workflow
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null or empty String is passed
PIMAuthorizationException
- Reserved for future useWorkflow createCategoryWorkflow(java.lang.String workflowName, java.lang.String workflowDescription)
workflowName
- the name for the new workflowworkflowDescription
- the description for the new workflow
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null or empty String is passed
PIMAuthorizationException
- Reserved for future usejava.util.Collection<Workflow> getWorkflows()
PIMInternalException
- If an internal error occursWorkflow getWorkflow(java.lang.String workflowName)
workflowName
- the name of the workflow to be retrieved
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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |