|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Workflow
Interface for the Workflow
object. Provides methods to
manipulate the internal MDMPIM Workflow object.
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
NestedWorkflowStep |
addNestedWorkflowStep(Workflow innerWorkflow)
Add another workflow as a nested workflow step into this workflow. |
WorkflowStep |
addStep(java.lang.String workflowStepName,
java.lang.String workflowStepDescription,
WorkflowStep.Type workflowStepType)
Add a workflow step to this workflow |
void |
delete()
Delete this workflow |
AccessControlGroup |
getAccessControlGroup()
Get the access control group of the workflow. |
java.util.Collection<CollaborationArea> |
getCollaborationAreas()
Get a collection of Collaboration areas that use this workflow |
java.lang.String |
getDescription()
Get the description of the Workflow. |
WorkflowStep |
getFailureStep()
Get the Failure Step of this workflow. |
Fixit |
getFixit()
Get Fixit for this Workflow |
java.util.Collection<Hierarchy> |
getHierarchiesForRecategorization()
Get the current hierarchies in use when recategorization items/categories from within collaboration areas based on this workflow. |
WorkflowStep |
getInitialStep()
Get the Initial Step of this workflow. |
java.lang.String |
getName()
Get the name of the Workflow. |
WorkflowStep |
getStep(java.lang.String workflowStepName)
Retrieve a workflow step from this workflow by name |
java.util.Collection<WorkflowStep> |
getSteps()
Get all the steps in this workflow. |
WorkflowStep |
getSuccessStep()
Get the Success Step of this workflow. |
boolean |
isCategoryWorkflow()
Check if this is a category workflow. |
boolean |
isInUse()
Report if the workflow is being used by any collaboration areas which are non-empty (if this is true, the workflow cannot be edited). |
boolean |
isItemWorkflow()
Check if this is an item workflow. |
void |
save()
Commit changes to the workflow design. |
void |
setAccessControlGroup(AccessControlGroup acg)
Set the access control group for a workflow. |
void |
setDescription(java.lang.String description)
Set the description of the workflow, overriding the current description. |
void |
setHierarchiesForRecategorization(java.util.Collection<Hierarchy> hierarchies)
Set a collection of hierarchies to be used when recategorizing items/categories from within this workflow. |
void |
setName(java.lang.String name)
Set the name of the workflow, overriding the current name. |
boolean |
validate()
Validate the workflow graph to determine whether it can be saved. |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
boolean isInUse()
PIMInternalException
- If an internal error occursvoid save()
PIMInternalException
- If an internal error occurs, or if the workflow graph cannot
be saved due to an invalid workflow graph, or if the workflow
is in use and therefore cannot be modified
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.WORKFLOW_EDIT
boolean validate()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usejava.util.Collection<Hierarchy> getHierarchiesForRecategorization()
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- Reserved for future usevoid setHierarchiesForRecategorization(java.util.Collection<Hierarchy> hierarchies)
hierarchies
- a Collection of hierarchies for use when recategorizing
items/categories within this workflow
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null Collection is passed
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.WORKFLOW_EDIT
java.lang.String getName()
PIMInternalException
- If an internal error occursjava.lang.String getDescription()
PIMInternalException
- If an internal error occursvoid setName(java.lang.String name)
name
- the new name for the workflow
PIMInternalException
- If an internal error occurs, or if a workflow with this name
already exists
java.lang.IllegalArgumentException
- If null or empty String is passed
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.WORKFLOW_EDIT
void setDescription(java.lang.String description)
description
- the new description for the workflow
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null Collection is passed
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.WORKFLOW_EDIT
void setAccessControlGroup(AccessControlGroup acg)
acg
- the new access control group for the workflow
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null Collection is passed
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.WORKFLOW_EDIT
AccessControlGroup getAccessControlGroup()
PIMInternalException
- If an internal error occursboolean isCategoryWorkflow()
PIMInternalException
- If an internal error occursboolean isItemWorkflow()
PIMInternalException
- If an internal error occursjava.util.Collection<WorkflowStep> getSteps()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usejava.util.Collection<CollaborationArea> getCollaborationAreas()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useWorkflowStep getInitialStep()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useWorkflowStep getSuccessStep()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useWorkflowStep getFailureStep()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useFixit getFixit()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useWorkflowStep addStep(java.lang.String workflowStepName, java.lang.String workflowStepDescription, WorkflowStep.Type workflowStepType)
workflowStepName
- the name for the new workflow stepworkflowStepDescription
- the description for the new workflow stepworkflowStepType
- the type for the new workflow step.
PIMInternalException
- If an internal error occurs, or if a step with the specified
name already exists, or if the specified type cannot be
created (e.g. because you cannot have two Initial steps)
java.lang.IllegalArgumentException
- If null or empty String/WorkflowStep.Type is passed
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.WORKFLOW_EDIT
NestedWorkflowStep addNestedWorkflowStep(Workflow innerWorkflow)
innerWorkflow
- the workflow to be used for the nested workflow step
PIMInternalException
- If an internal error occurs, or if the Workflow cannot be
used as an inner workflow (for example, because it is the
same Workflow to be added to, which would create an infinite
loop)
java.lang.IllegalArgumentException
- If null Workflow is passed
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.WORKFLOW_EDIT
void delete()
PIMInternalException
- If an internal error occurs, or if the workflow is in use and
therefore cannot be modified
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.WORKFLOW_DELETE
WorkflowStep getStep(java.lang.String workflowStepName)
workflowStepName
- the name of the step to be retrieved
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If null or empty String is passed
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |