|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Workflow
Represents a workflow.
A Workflow
consists of WorkflowStages
in a
specific order. Workflowing controls access to and manages the progression
of WCM objects through the specified WorkflowStages
.
WorkflowStage
Nested Class Summary | |
---|---|
static class |
Workflow.DraftCreationBehavior
The Workflow.DraftCreationBehavior controls how items using the Workflow can create new drafts |
Method Summary | |
---|---|
Workflow.DraftCreationBehavior |
getDraftCreationBehavior()
Returns the Workflow.DraftCreationBehavior for this Workflow . |
int |
getNumStages()
Returns the number of stages in this Workflow . |
DocumentId |
getRejectStageId()
Returns the DocumentId of the WorkflowStage documents will be placed into
if they fail approval |
DocumentIdIterator |
getStagesIterator()
Returns an iterator of DocumentId objects of the
WorkflowStages in this Workflow . |
DocumentId |
getTargetStageIdForProjectItems()
Returns the DocumentId of the WorkflowStage that documents will be placed
into when the project they are associated with publishes |
boolean |
isCommentRequiredOnApproval()
Indicates if a comment is required on approval |
boolean |
isWorkflowDisabledInProjects()
Indicates if this workflow is disabled for items in projects |
void |
setCommentRequiredOnApproval(boolean commentRequired)
Specifies whether a comment is required on approval |
void |
setDraftCreationBehaviour(Workflow.DraftCreationBehavior behavior)
Sets the Workflow.DraftCreationBehavior for this Workflow . |
void |
setRejectStageId(DocumentId rejectStageId)
Specifies the DocumentId of the WorkflowStage documents will be placed into
if they fail approval |
void |
setStages(java.util.List<WorkflowStage> workflowStages)
Sets the ordered list of WorkflowStage 's in this Workflow |
void |
setStages(WorkflowStage... workflowStages)
Sets the ordered list of WorkflowStage 's in this Workflow |
void |
setTargetStageIdForProjectItems(DocumentId workflowStageId)
Sets the DocumentId of the WorkflowStage that documents will be placed
into when the project they are associated with publishes AND has the effect of disabling workflow in projects |
Methods inherited from interface com.ibm.workplace.wcm.api.Item |
---|
getCreationDate, getDescription, getIdentity, getModifiedDate, getName, getTitle |
Methods inherited from interface com.ibm.portal.Localized |
---|
getLocales |
Methods inherited from interface com.ibm.workplace.wcm.api.EditableItem |
---|
setDescription, setName, setTitle |
Method Detail |
---|
int getNumStages() throws com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
Workflow
.
Workflow
com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
- if the number of stages cannot
be calculatedDocumentIdIterator getStagesIterator()
DocumentId
objects of the
WorkflowStages
in this Workflow
.
Returns an empty iterator if no workflow stages have been specified.
DocumentId
objects of the
WorkflowStages
in this Workflow
.void setStages(WorkflowStage... workflowStages)
WorkflowStage
's in this Workflow
Will overwrite the previous list
workflowStages
- the workflow stagesvoid setStages(java.util.List<WorkflowStage> workflowStages)
WorkflowStage
's in this Workflow
Will overwrite the previous list
workflowStages
- the workflow stagesWorkflow.DraftCreationBehavior getDraftCreationBehavior()
Workflow.DraftCreationBehavior
for this Workflow
. This
property governs how published or expired items using this Workflow
to control the creation of drafts.
Workflow.DraftCreationBehavior
selected for this Workflow
void setDraftCreationBehaviour(Workflow.DraftCreationBehavior behavior)
Workflow.DraftCreationBehavior
for this Workflow
.
behavior
- the Workflow.DraftCreationBehavior
to setboolean isCommentRequiredOnApproval()
void setCommentRequiredOnApproval(boolean commentRequired)
commentRequired
- true if a comment should be required, false otherwiseDocumentId getRejectStageId() throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
DocumentId
of the WorkflowStage
documents will be placed into
if they fail approval
DocumentId
of the WorkflowStage
documents will be placed into
if they fail approval or NULL
if a reject stage has not been set
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have the appropriate access to the reject workflow stage
com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
- if the reject workflow stage id could not be retrievedvoid setRejectStageId(DocumentId rejectStageId) throws com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
DocumentId
of the WorkflowStage
documents will be placed into
if they fail approval
rejectStageId
- the reject stage id. Passing in NULL
will clear the reject stage
com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
- if the supplied DocumentId
is not of type DocumentTypes.WorkflowStage
boolean isWorkflowDisabledInProjects()
To disable workflow in projects, see the setTargetStageIdForProjectItems
method
setTargetStageIdForProjectItems(com.ibm.workplace.wcm.api.DocumentId)
DocumentId getTargetStageIdForProjectItems() throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
DocumentId
of the WorkflowStage
that documents will be placed
into when the project they are associated with publishes
DocumentId
of the WorkflowStage
that documents will be placed
into when they are added to a project OR NULL
if workflow is not disabled in projects
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have the appropriate access to the target workflow stage
com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
- if the target workflow stage id could not be retrievedvoid setTargetStageIdForProjectItems(DocumentId workflowStageId) throws com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException, com.ibm.workplace.wcm.api.exceptions.OperationFailedException
DocumentId
of the WorkflowStage
that documents will be placed
into when the project they are associated with publishes AND has the effect of disabling workflow in projects
workflowStageId
- the DocumentId
of the WorkflowStage
to set. Passing in
NULL
will re-enable workflow for projects
com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
- if the supplied DocumentId
is not of type DocumentTypes.WorkflowStage
com.ibm.workplace.wcm.api.exceptions.OperationFailedException
- if the specified WorkflowStage is not in the list of stages for this Workflow
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |