+

Search Tips | Advanced Search

com.ibm.workplace.wcm.api
Interface WorkflowedDocument

All Known Subinterfaces:

Category, Content, ContentComponentContainer, EditableLibraryComponent, LibraryDateComponent, LibraryDocumentManagerComponent, LibraryFileComponent, LibraryHTMLComponent, LibraryImageComponent, LibraryJSPComponent, LibraryLinkComponent, LibraryNumericComponent, LibraryRichTextComponent, LibraryShortTextComponent, LibraryStyleSheetComponent, LibraryTextComponent, LibraryUserSelectionComponent, PresentationTemplate, Site, SiteArea, SiteFrameworkContainer, Taxonomy

public interface WorkflowedDocument

WorkflowedDocument Interface Represents a WCM API object that supports workflow methods WorkflowedDocument description

Method Summary

void	addAdditionalViewers(java.lang.String[] additionalViewers) Adds names to the list of additional live viewers for this Document document.
void	addApprovers(java.lang.String[] approvers) Adds each approver specified in the string array argument to the approvers of this Document object.
Document	cancelDraftDocument() Cancels a draft document, if it exists.
Document	createDraftDocument() Create draft copy of this WorkflowedDocument object.
void	decline() Declines this document.
java.lang.String[]	getAdditionalViewers() Returns an array of names of additional live viewers for this Document document.
java.lang.String[]	getCurrentApprovers() Returns a string array of members who have Approver access to this Document object.
java.util.Date	getEffectiveDate() Returns the effective date of this Document.
java.util.Date	getExpiryDate() Returns the expiry date for this Document document.
java.util.Date	getGeneralDateOne() Return general date one for this Document document.
java.util.Date	getGeneralDateTwo() Return general date two for this Document document.
DocumentId	getWorkflowId() Return ID of the workflow associated with this document.
DocumentId	getWorkflowStageId() Returns the ID of the current WorkflowStage that this Document document is in.
boolean	hasApproverAccess() Checks if the user of the Workspace associated with the current document has Approver access to this Document.
boolean	hasApproverAccess(UserProfile user) Checks if the UserProfile has Approver access to this Document.
boolean	hasDraft() Returns true if this Document has a draft document.
boolean	isDraft() Return true if this Document object is a draft.
boolean	isExpired() Return true if this Document has expired.
boolean	isPublished() Return true if this Document document is live published document.
void	nextWorkflowStage() Move this Document object into the next stage in its workflow.
void	nextWorkflowStage(boolean p_runExitActions, boolean p_runEntryActions) Move this Document object into the next stage in its workflow.
void	removeAdditionalViewers(java.lang.String[] additionalViewers) Removes names from the list of additional live viewers for this Document.
void	removeApprovers(java.lang.String[] approvers) Removes each approver specified in the string array argument from the approvers of this Document object.
void	restartWorkflow() Restart the workflow on this Document object.
void	setEffectiveDate(java.util.Date effectiveDate) Sets the effective date of this Document document.
void	setExpiryDate(java.util.Date expiryDate) Sets the expiry date for this Document document.
void	setGeneralDateOne(java.util.Date generalDateOne) Set general date one for this Document document.
void	setGeneralDateTwo(java.util.Date generalDateTwo) Set general date two for this Document document.
void	setWorkflowId(DocumentId workflowId) Sets the Workflow on this Document given the ID of the Workflow.
void	setWorkflowId(DocumentId workflowId, boolean maintainCurrentStage) Sets the Workflow on this Document given the ID of the Workflow.

Method Detail

getWorkflowId

DocumentId getWorkflowId()
                         throws AuthorizationException,
                                PropertyRetrievalException

Return ID of the workflow associated with this document. If the user does not have access to the Workflow, an AuthorizationException will be thrown. null will never be returned from this method.

Returns:

the ID of the Workflow for this Document

Throws:

AuthorizationException - if the user does not have the appropriate access to the workflow

PropertyRetrievalException - if this document is not workflowable or the workflow id cannot be retrieved

setWorkflowId

 void setWorkflowId(DocumentId workflowId)
                   throws OperationFailedException

Sets the Workflow on this Document given the ID of the Workflow. This method will also restart the workflow of the current document

Parameters:

workflowId - the ID for the required Workflow

Throws:

OperationFailedException - if this document is not workflowable or the workflow ID could not be set

setWorkflowId

 void setWorkflowId(DocumentId workflowId,
                   boolean maintainCurrentStage)
                   throws OperationFailedException

Sets the Workflow on this Document given the ID of the Workflow. If maintainCurrentStage is false OR the current stage doesn't exist in the new workflow, then this method will also restart the workflow of the current document

Parameters:

workflowId - the ID for the required Workflow

maintainCurrentStage - specifies whether to stay in the current stage (and not run any workflow actions OR re-apply security) if it exists in the new Workflow

Throws:

OperationFailedException - if this document is not workflowable or the workflow id could not be set

getWorkflowStageId

DocumentId getWorkflowStageId()
                              throws AuthorizationException,
                                     PropertyRetrievalException

Returns the ID of the current WorkflowStage that this Document document is in. If the user does not have access to this stage, then an AuthorizationException is thrown. null is never returned.

Returns:

the ID of the current WorkflowStage of this document

Throws:

AuthorizationException - if the user does not have the appropriate access to the current workflow stage

PropertyRetrievalException - if this document is not workflowable or the workflow stage id could not be retrieved

getEffectiveDate

 java.util.Date getEffectiveDate()
                                throws PropertyRetrievalException

Returns the effective date of this Document. That is, the date this Document will become live.

Returns:

the effective date

Throws:

PropertyRetrievalException - if this document is not workflowable

setEffectiveDate

 void setEffectiveDate(java.util.Date effectiveDate)
                      throws OperationFailedException

Sets the effective date of this Document document. That is, the date the Document will become live.

Parameters:

effectiveDate - the effective date

Throws:

OperationFailedException - if this document is not workflowable

getExpiryDate

 java.util.Date getExpiryDate()
                             throws PropertyRetrievalException

Returns the expiry date for this Document document. That is, the date it will expire from site.

Returns:

the expiry date

Throws:

PropertyRetrievalException - if this document is not workflowable

setExpiryDate

 void setExpiryDate(java.util.Date expiryDate)
                   throws OperationFailedException

Sets the expiry date for this Document document. That is, the date the Document will expire from site.

Parameters:

expiryDate - the expiry date

Throws:

OperationFailedException - if this document is not workflowable

getGeneralDateOne

 java.util.Date getGeneralDateOne()
                                 throws PropertyRetrievalException

Return general date one for this Document document. That is, the date that the user has specified.

Returns:

General date one

Throws:

PropertyRetrievalException - if this document is not workflowable

setGeneralDateOne

 void setGeneralDateOne(java.util.Date generalDateOne)
                       throws OperationFailedException

Set general date one for this Document document. That is, the date that the user has specified.

Parameters:

generalDateOne - the general date one

Throws:

OperationFailedException - if this document is not workflowable

getGeneralDateTwo

 java.util.Date getGeneralDateTwo()
                                 throws PropertyRetrievalException

Return general date two for this Document document. That is, the date that the user has specified.

Returns:

General date Two

Throws:

PropertyRetrievalException - if this document is not workflowable

setGeneralDateTwo

 void setGeneralDateTwo(java.util.Date generalDateTwo)
                       throws OperationFailedException

Set general date two for this Document document. That is, the date that the user has specified.

Parameters:

generalDateTwo - the general date two

Throws:

OperationFailedException - if this document is not workflowable

getAdditionalViewers

 java.lang.String[] getAdditionalViewers()
                                        throws PropertyRetrievalException

Returns an array of names of additional live viewers for this Document document.

Returns:

an array of names of users or groups listed as additional viewers

Throws:

PropertyRetrievalException - if this document is not workflowable

addAdditionalViewers

 void addAdditionalViewers(java.lang.String[] additionalViewers)
                          throws OperationFailedException

Adds names to the list of additional live viewers for this Document document. Duplicate names are removed.

Parameters:

additionalViewers - the array of additional viewer names to add

Throws:

OperationFailedException - if this document is not workflowable

removeAdditionalViewers

 void removeAdditionalViewers(java.lang.String[] additionalViewers)
                             throws OperationFailedException

Removes names from the list of additional live viewers for this Document. All names in the specified array will be removed.

Parameters:

additionalViewers - the array of additional viewer names to remove

Throws:

OperationFailedException - if this document is not workflowable

getCurrentApprovers

 java.lang.String[] getCurrentApprovers()
                                       throws PropertyRetrievalException

Returns a string array of members who have Approver access to this Document object. 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 this Document object does not have Approver access specified.

Returns:

a string array of members that have Approver access to this Document object.

Throws:

PropertyRetrievalException - if this document is not workflowable, or the current stage is not accessible by this user

hasApproverAccess

 boolean hasApproverAccess(UserProfile user)
                          throws OperationFailedException

Checks if the UserProfile has Approver access to this Document.

Parameters:

user - the UserProfile to perform the access check for

Returns:

true if this user has Approver access, false if not

Throws:

OperationFailedException - if error occured when accessing repository

hasApproverAccess

 boolean hasApproverAccess()
                          throws OperationFailedException

Checks if the user of the Workspace associated with the current document has Approver access to this Document.

Returns:

true if this user has Approver access, false if not

Throws:

OperationFailedException - if error occured when accessing repository

addApprovers

 void addApprovers(java.lang.String[] approvers)

Adds each approver specified in the string array argument to the approvers of this Document object.

An approver is only added if the element in the string array argument can be converted to a valid member.

Note: Each approver of this Document object must be unique. I.e. Duplicates are removed.

Parameters:

approvers - the approvers to add

removeApprovers

 void removeApprovers(java.lang.String[] approvers)

Removes each approver specified in the string array argument from the approvers of this Document object.

An approver is only removed if the element in the string array argument can be converted to a valid member and already an approver on this Document object.

Parameters:

approvers - the approvers names to remove

hasDraft

 boolean hasDraft()
                 throws PropertyRetrievalException

Returns true if this Document has a draft document.

Returns:

true if this Document has a draft document, false otherwise.

Throws:

PropertyRetrievalException - if this document is not workflowable

restartWorkflow

 void restartWorkflow()
                     throws AuthorizationException,
                            OperationFailedException

Restart the workflow on this Document object. This returns the document to the first stage in its workflow.

Throws:

AuthorizationException - if the user does not have the appropriate access permission

OperationFailedException - if this document is not workflowable or an error while restarting the workflow

nextWorkflowStage

 void nextWorkflowStage()
                       throws AuthorizationException,
                              OperationFailedException,
                              NoMoreWorkflowStagesException

Move this Document object into the next stage in its workflow. When an approver calls this method, the document will immediately progress to the next workflow stage regardless of whether joint approval has been configured.

Throws:

AuthorizationException - if the user does not have the appropriate access permission to the workflow

OperationFailedException - if this document is not workflowable or the document could not be moved to the next workflow stage

NoMoreWorkflowStagesException - if the document is already in the last workflow stage

nextWorkflowStage

 void nextWorkflowStage(boolean p_runExitActions,
                       boolean p_runEntryActions)
                       throws AuthorizationException,
                              OperationFailedException,
                              NoMoreWorkflowStagesException

Move this Document object into the next stage in its workflow. When an approver calls this method, the document will immediately progress to the next workflow stage regardless of whether joint approval has been configured.

Parameters:

p_runExitActions - specifies whether to run the exit actions on the current stage before proceeding to the next stage

p_runEntryActions - specifies whether to run the entry actions on the next stage

Throws:

AuthorizationException - if the user does not have the appropriate access permission to the workflow

OperationFailedException - if this document is not workflowable or the Document could not be moved to the next workflow stage

NoMoreWorkflowStagesException - if the document is already in the last workflow stage

isDraft

 boolean isDraft()
                throws PropertyRetrievalException

Return true if this Document object is a draft.

Returns:

true if it is a draft

Throws:

PropertyRetrievalException - if this document is not workflowable

isPublished

 boolean isPublished()
                    throws PropertyRetrievalException

Return true if this Document document is live published document.

Returns:

true if this document is published

Throws:

PropertyRetrievalException - if this document is not workflowable

isExpired

 boolean isExpired()
                  throws PropertyRetrievalException

Return true if this Document has expired. That is, if the expiry date has been reached.

Returns:

true if the document has expired

Throws:

PropertyRetrievalException - if this document is not workflowable

decline

 void decline()
             throws AuthorizationException,
                    OperationFailedException

Declines this document. This returns it to the first stage in the workflow.

Throws:

AuthorizationException - if the user does not have the appropriate access permission to the workflow

OperationFailedException - if this document is not workflowable or the Document could not be moved to the initial workflow stage

createDraftDocument

Document createDraftDocument()
                             throws AuthorizationException,
                                    OperationFailedException

Create draft copy of this WorkflowedDocument object.

NOTE: Creating a draft saves the original, so any changes already made to the original before a draft is created will be seen in both WorkflowedDocuments.

NOTE: You do not need to save the new draft after it is created, unless you have made changes to the draft WorkflowedDocument after creating the draft.

Returns:

the draft WorkflowedDocument copy

Throws:

AuthorizationException - if the user does not have the appropriate access permission

OperationFailedException - if this WorkflowedDocument is not workflowable or an error occurred while creating the draft

cancelDraftDocument

Document cancelDraftDocument()
                             throws AuthorizationException,
                                    OperationFailedException

Cancels a draft document, if it exists.

NOTE: This method may be performed on either the draft or the published document.

Returns:

The associated published document. If there is no draft to cancel, this will return null.

Throws:

AuthorizationException - if the user does not have the appropriate access permission

OperationFailedException - if this document is not workflowable or an error occurred while cancelling the draft