com.ibm.workplace.wcm.api
Interface Workflow

All Superinterfaces:

Document

public interface Workflow

extends Document

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.

A Workflow cannot be created, edited or deleted through the API. It must already exist in the repository.

See Also:

WorkflowStage

Field Summary

static java.lang.String

COPYRIGHT Copyright statement

Method Summary

int	getNumStages() Returns the number of stages in this Workflow.
DocumentIdIterator	getStagesIterator() Returns an iterator of DocumentId objects of the WorkflowStages in this Workflow.

Methods inherited from interface com.ibm.workplace.wcm.api.Document

getAuthors, getDeleteAccessMembers, getDescription, getEditAccessMembers, getId, getLiveAccessMembers, getName, getOwners, getReadAccessMembers

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

Copyright statement

See Also:

Constant Field Values

Method Detail

getNumStages

public int getNumStages()
                 throws PropertyRetrievalException

Returns the number of stages in this Workflow.

Returns:

the number of stages in this Workflow

Throws:

PropertyRetrievalException - if the number of stages cannot be calculated

getStagesIterator

public DocumentIdIterator getStagesIterator()

Returns an iterator of DocumentId objects of the WorkflowStages in this Workflow.

Returns an empty iterator if no workflow stages have been specified.

Returns:

an iterator of DocumentId objects of the WorkflowStages in this Workflow.