|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkflowStage
Represents a workflow stage.
A WorkflowStage
consists of WorkflowActions
in a
specific order. Workflowing controls access to and manages the progression
of WCM objects through specified WorkflowStages
.
Nested Class Summary | |
---|---|
static class |
WorkflowStage.ACTION_GROUP
The list of possible workflow action groups |
Method Summary | |
---|---|
void |
addActions(WorkflowStage.ACTION_GROUP actionGroup,
DocumentId... workflowActionIds)
Adds WorkflowActions to the end of the actions for this WorkflowStage |
void |
addActions(WorkflowStage.ACTION_GROUP actionGroup,
java.util.List<DocumentId> workflowActionIds)
Adds WorkflowActions to the end of the actions for this WorkflowStage |
void |
addJointApprovers(java.lang.String... members)
Add members as joint approvers. |
void |
addMembersForWorkflowDefinedAccess(Access access,
java.util.Collection<java.lang.String> members)
Adds the specified members to the specified access level for this WorkflowStage |
void |
addMembersForWorkflowDefinedAccess(Access access,
java.lang.String... members)
Adds the specified members to the specified access level for this WorkflowStage |
void |
clearActions(WorkflowStage.ACTION_GROUP actionGroup)
Removes all WorkflowActions of the specified type from this WorkflowStage |
void |
clearJointApprovers()
Remove all members from the set of joint approvers. |
void |
clearMembersForWorkflowDefinedAccess(Access access)
Removes all members of the specified access level for this WorkflowStage |
int |
getActionCount(WorkflowStage.ACTION_GROUP actionGroup)
Returns the number of actions for the specified ACTION_GROUP in this WorkflowStage . |
DocumentIdIterator |
getActions(WorkflowStage.ACTION_GROUP actionGroup)
Returns an iterator of DocumentId objects of the WorkflowActions for the given
ACTION_GROUP in this WorkflowStage . |
java.lang.String[] |
getJointApprovers()
Get the joint approvers currently defined. |
java.lang.String[] |
getMembersForWorkflowDefinedAccess(Access access)
Get the members who have been selected for the specified access level for this WorkflowStage . |
boolean |
isCommentOnApprovalEnabled()
Indicates if this WorkflowStage has commenting enabled on approval |
boolean |
isInheritanceEnabledForWorkflowDefinedAccess(Access access)
Checks if the Access permissions are set to be inherited for items that
enter this stage during their workflow cycle. |
boolean |
isJointApprovalEnabled()
Indicates if this WorkflowStage is using Joint Approval |
boolean |
isPreviousStageEnabled()
Indicates if the moving to previous stage is enabled (for non-managers) for this WorkflowStage . |
boolean |
isPropagationEnabledForWorkflowDefinedAccess(Access access)
Checks if the Access permissions are set to be propagated for items that
enter this stage during their workflow cycle. |
void |
removeActions(WorkflowStage.ACTION_GROUP actionGroup,
DocumentId... workflowActionIds)
Removes WorkflowActions from this WorkflowStage |
void |
removeActions(WorkflowStage.ACTION_GROUP actionGroup,
java.util.List<DocumentId> workflowActionIds)
Removes WorkflowActions from this WorkflowStage |
void |
removeJointApprovers(java.lang.String... members)
Remove members from the set of joint approvers. |
void |
removeMembersForWorkflowDefinedAccess(Access access,
java.util.Collection<java.lang.String> members)
Removes the specified members to the specified access level for this WorkflowStage |
void |
removeMembersForWorkflowDefinedAccess(Access access,
java.lang.String... members)
Removes the specified members to the specified access level for this WorkflowStage |
void |
setCommentOnApprovalEnabled(boolean enableCommentOnApproval)
Specifies whether this WorkflowStage should require comments on approval |
void |
setInheritanceEnabledForWorkflowDefinedAccess(Access access,
boolean isInherited)
Specifies if the Access permissions are set to be inherited for items that
enter this stage during their workflow cycle. |
void |
setJointApprovalEnabled(boolean jointApprovalEnabled)
Specifies whether this WorkflowStage should use Joint Approval |
void |
setPreviousStageEnabled(boolean enableMovingPreviousStage)
Specifies whether Document 's in this WorkflowStage should be allowed
to be moved back to the previous stage |
void |
setPropagationEnabledForWorkflowDefinedAccess(Access access,
boolean isPropagated)
Specifies if the Access permissions are set to be propagated for items that
enter this stage during their workflow cycle. |
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 getActionCount(WorkflowStage.ACTION_GROUP actionGroup)
ACTION_GROUP
in this WorkflowStage
.
actionGroup
- The ACTION_GROUP
to query
ACTION_GROUP
in this WorkflowStage
.DocumentIdIterator getActions(WorkflowStage.ACTION_GROUP actionGroup)
DocumentId
objects of the WorkflowActions
for the given
ACTION_GROUP
in this WorkflowStage
.
Returns an empty iterator if no workflow actions have been specified for the given
ACTION_GROUP
.
actionGroup
- The ACTION_GROUP
to query
DocumentId
objects of the WorkflowActions
for the given
ACTION_GROUP
in this WorkflowStage
.void addActions(WorkflowStage.ACTION_GROUP actionGroup, DocumentId... workflowActionIds) throws com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
WorkflowActions
to the end of the actions for this WorkflowStage
actionGroup
- The type of action to addworkflowActionIds
- The DocumentId
's of the WorkflowActions
to add
com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
- if any of the supplied DocumentId
's are not a WorkflowStage
void addActions(WorkflowStage.ACTION_GROUP actionGroup, java.util.List<DocumentId> workflowActionIds) throws com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
WorkflowActions
to the end of the actions for this WorkflowStage
actionGroup
- The type of action to addworkflowActionIds
- The DocumentId
's of the WorkflowActions
to add
com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
- if any of the supplied DocumentId
's are not a WorkflowStage
void removeActions(WorkflowStage.ACTION_GROUP actionGroup, DocumentId... workflowActionIds) throws com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
WorkflowActions
from this WorkflowStage
actionGroup
- The type of action to removeworkflowActionIds
- The DocumentId
's of the WorkflowActions
to remove
com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
- if any of the supplied DocumentId
's are not a WorkflowStage
void removeActions(WorkflowStage.ACTION_GROUP actionGroup, java.util.List<DocumentId> workflowActionIds) throws com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
WorkflowActions
from this WorkflowStage
actionGroup
- The type of action to removeworkflowActionIds
- The DocumentId
's of the WorkflowActions
to remove
com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
- if any of the supplied DocumentId
's are not a WorkflowStage
void clearActions(WorkflowStage.ACTION_GROUP actionGroup)
WorkflowActions
of the specified type from this WorkflowStage
actionGroup
- The type of action to removeboolean isJointApprovalEnabled()
WorkflowStage
is using Joint Approval
WorkflowStage
is using Joint Approval, false otherwisevoid setJointApprovalEnabled(boolean jointApprovalEnabled)
WorkflowStage
should use Joint Approval
jointApprovalEnabled
- true if Joint Approval is requested, false otherwisevoid addJointApprovers(java.lang.String... members)
Note that adding a joint approver does not give approve access. The user must inherit approver access, or have it explicitly assigned.
members
- the members to add as joint approversvoid removeJointApprovers(java.lang.String... members)
members
- void clearJointApprovers()
java.lang.String[] getJointApprovers()
boolean isCommentOnApprovalEnabled()
WorkflowStage
has commenting enabled on approval
WorkflowStage
has commenting enabled on approval, false otherwisevoid setCommentOnApprovalEnabled(boolean enableCommentOnApproval)
WorkflowStage
should require comments on approval
enableCommentOnApproval
- true if comments should be enabled false otherwiseboolean isPreviousStageEnabled()
WorkflowStage
.
WorkflowStage
false otherwise.void setPreviousStageEnabled(boolean enableMovingPreviousStage)
Document
's in this WorkflowStage
should be allowed
to be moved back to the previous stage
enableMovingPreviousStage
- true to enable moving to the previous stage, false otherwisejava.lang.String[] getMembersForWorkflowDefinedAccess(Access access)
WorkflowStage
. These members will
be set on items as they enter this stage during their Workflow cycle.
The strings are either the users' common name or distinguished name,
depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed()
.
The resultant array may contain the names of users and groups.
Returns an empty array if no user is explicitly granted the specified access on this WorkflowStage
object.
access
- the access to query the members for.
WorkflowStage
object.void addMembersForWorkflowDefinedAccess(Access access, java.lang.String... members)
WorkflowStage
The strings should be either the users' common name or distinguished name,
depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed()
.
access
- the accesss to add the members tomembers
- the members to addvoid addMembersForWorkflowDefinedAccess(Access access, java.util.Collection<java.lang.String> members)
WorkflowStage
The strings should be either the users' common name or distinguished name,
depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed()
.
access
- the accesss to add the members tomembers
- the members to addvoid removeMembersForWorkflowDefinedAccess(Access access, java.lang.String... members)
WorkflowStage
The strings should be either the users' common name or distinguished name,
depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed()
.
access
- the accesss to remove the members frommembers
- the members to removevoid removeMembersForWorkflowDefinedAccess(Access access, java.util.Collection<java.lang.String> members)
WorkflowStage
The strings should be either the users' common name or distinguished name,
depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed()
.
access
- the accesss to remove the members frommembers
- the members to removevoid clearMembersForWorkflowDefinedAccess(Access access)
WorkflowStage
access
- the accesss to remove the members fromboolean isInheritanceEnabledForWorkflowDefinedAccess(Access access)
Access
permissions are set to be inherited for items that
enter this stage during their workflow cycle.
access
- the access to query the inheritance for.
boolean isPropagationEnabledForWorkflowDefinedAccess(Access access)
Access
permissions are set to be propagated for items that
enter this stage during their workflow cycle.
access
- the access level to query propagation for.
void setInheritanceEnabledForWorkflowDefinedAccess(Access access, boolean isInherited)
Access
permissions are set to be inherited for items that
enter this stage during their workflow cycle.
access
- the access to modify the inheritance forisInherited
- true to enable inheritance, false to disable itvoid setPropagationEnabledForWorkflowDefinedAccess(Access access, boolean isPropagated)
Access
permissions are set to be propagated for items that
enter this stage during their workflow cycle.
access
- the access level to modify the propagation forisPropagated
- true to enable propagation, false to disable.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |