|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProjectPrototype
Models the prototype of a ProjectTemplate
Method Summary | |
---|---|
void |
addApprovers(java.lang.String... approverNames)
Add the given names as approvers on this object. |
void |
clearApprovers()
A convenient method to remove all approvers from the object. |
void |
clearWorkflowActionsForState(ProjectStateSelectors.State state)
A convenient method to clear all WorkflowAction s currently associated with the given State . |
Project.ApprovalMode |
getApprovalMode()
Get the ApprovalMode set on this object. |
Project.CommentMode |
getCommentMode()
Gets the CommentMode set on this project. |
java.lang.String[] |
getCurrentApprovers()
Returns a string array of members who have Approver access to this object. |
Project.PublishOptions |
getPublishOption()
Get the PublishOption set on this object. |
DocumentId[] |
getWorkflowActionsForState(ProjectStateSelectors.State state)
Get the list of WorkflowAction s associated with the given project State . |
void |
removeApprovers(java.lang.String... approvers)
Removes the given approvers from the approver list for this object. |
void |
setApprovalMode(Project.ApprovalMode approvalMode)
Set the ApprovalMode on this object. |
void |
setCommentMode(Project.CommentMode commentMode)
Sets the CommentMode for this project. |
void |
setPublishOption(Project.PublishOptions publishOption)
Set the given PublishOptions on this object. |
void |
setWorkflowActionsForState(ProjectStateSelectors.State state,
DocumentId... workflowActionDocumentIds)
Set the given WorkflowAction s for the specified State on this object. |
Method Detail |
---|
void setPublishOption(Project.PublishOptions publishOption)
PublishOptions
on this object.
publishOption
- the PublishOptions
to be set.
java.lang.IllegalArgumentException
- if the given PublishOptions
is null.Project.PublishOptions getPublishOption()
PublishOption
set on this object.
PublishOptions
void setApprovalMode(Project.ApprovalMode approvalMode)
ApprovalMode
on this object.
approvalMode
- the ApprovalMode
to be set.
java.lang.IllegalArgumentException
- if the argument is null.
java.lang.IllegalStateException
- if invoked on a Project
and the project's current state is not ACTIVE
.Project.ApprovalMode getApprovalMode()
ApprovalMode
set on this object.
ApprovalMode
void setCommentMode(Project.CommentMode commentMode)
CommentMode
for this project.
commentMode
- the CommentMode
to be set on this ptototype.
java.lang.IllegalArgumentException
- if the given CommentMode
is null.Project.CommentMode getCommentMode()
CommentMode
set on this project.
CommentMode
.void addApprovers(java.lang.String... approverNames)
approverNames
- the names of users and/or groups to be set as approvers on this object.
These names are either the common names or distinguished names,
depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed()
.
java.lang.IllegalStateException
- if invoked on a Project
and the project's current state is not ACTIVE
.void removeApprovers(java.lang.String... approvers)
An approver is only removed if it can be converted to a valid member and is already in the list of approvers for this object.
Note: Each approver is either a user's common name or distinguished name
depending on the setting on the Workspace
. See Workspace.isDistinguishedNamesUsed()
.
approvers
- the approvers names to remove from this object.
java.lang.IllegalStateException
- if invoked on a Project
and the project's current state is not ACTIVE
.void clearApprovers()
removeApprovers(String...)
java.lang.IllegalStateException
- if invoked on a Project
and the project's current state is not ACTIVE
.java.lang.String[] getCurrentApprovers() throws com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
Workspace.isDistinguishedNamesUsed()
.
The resultant array may contain the names of users and groups.
Returns an empty array if this object does not have Approver access specified.
com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
- if this document is not workflowable,
or the current stage is not accessible by this uservoid setWorkflowActionsForState(ProjectStateSelectors.State state, DocumentId... workflowActionDocumentIds)
WorkflowAction
s for the specified State
on this object.
This list will override any existing actions associated with the defined State
.
The given WorkflowAction
s will be added and executed in the defined order.
Duplicate WorkflowAction
s will be ignored.
state
- the non-null project State
to set the WorkflowAction
on.
All project State
s except ACTIVE
support WorkflowAction
.workflowActionDocumentIds
- a non-null, non-empty list of DocumentId
whose type must be assignable to that of a WorkflowAction
.
java.lang.IllegalArgumentException
- if the specified state is null or does not support WorkflowAction
.
or the DocumentId
array is null or empty,
or if no WorkflowAction
object exists for a given DocumentId
.
java.lang.IllegalStateException
- if invoked on a Project
and the project's current state is not ACTIVE
.void clearWorkflowActionsForState(ProjectStateSelectors.State state)
WorkflowAction
s currently associated with the given State
.
state
- the project State
to clear all the associated WorkflowAction
for.
java.lang.IllegalArgumentException
- if the specified state is null.
java.lang.IllegalStateException
- if the project's current State
is not ACTIVE
.DocumentId[] getWorkflowActionsForState(ProjectStateSelectors.State state)
WorkflowAction
s associated with the given project State
.
If the given project State
has no WorkflowAction
associated with it
then an empty array will be returned.
state
- the non-null project state to query associated WorkflowAction
s for.
WorkflowAction
s, defined on the given project State
,
or an empty array is there is none.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |