com.lexmark.saperion.workflow

Interface WorkflowDefinitionService

All Superinterfaces:

SearchExecutionService<WorkflowDefinitionListItemType>

public interface WorkflowDefinitionService
extends SearchExecutionService<WorkflowDefinitionListItemType>

This service provides functionality concerning workflow definitions.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
TransitionDefinitionType	getInitialTransition(WorkflowDefinitionReferenceType reference) This method returns the initial transition definition for the referenced workflow.
WorkflowDefinitionType	getWorkflowDefinitionById(WorkflowDefinitionReferenceType reference) This method returns further information for a workflow process given by its reference.
SearchResultPage<WorkflowDefinitionListItemType>	search(Statement statement, PageDefinition pageDefinition) This method returns a list of references for every workflow definition in the system accessible from the current tenant.
WorkflowProcessReferenceType	startWorkflowProcess(WorkflowDefinitionReferenceType workflowDefinitionReference, DocumentReferenceType documentId, List<? extends ActorReferenceType> actors, String comment) This method starts a workflow process given a workflow definition and a document (by its id).

Method Detail

search

SearchResultPage<WorkflowDefinitionListItemType> search(Statement statement,
                                                        PageDefinition pageDefinition)
                                                 throws EcmException

This method returns a list of references for every workflow definition in the system accessible from the current tenant.

Specified by:

search in interface SearchExecutionService<WorkflowDefinitionListItemType>

Parameters:

statement - search expression

pageDefinition - result page offset and size

Returns:

a list of every workflow definition in the system accessible from the current tenant

Throws:

SearchException - indicates any error during the search operation

EcmException

getWorkflowDefinitionById

WorkflowDefinitionType getWorkflowDefinitionById(WorkflowDefinitionReferenceType reference)
                                          throws EcmException

This method returns further information for a workflow process given by its reference.

Parameters:

reference - a reference of the workflow process to obtain the information for

Returns:

further information for a workflow process given by its reference

Throws:

EcmException

startWorkflowProcess

WorkflowProcessReferenceType startWorkflowProcess(WorkflowDefinitionReferenceType workflowDefinitionReference,
                                                  DocumentReferenceType documentId,
                                                  List<? extends ActorReferenceType> actors,
                                                  String comment)
                                           throws EcmException

This method starts a workflow process given a workflow definition and a document (by its id).

Parameters:

workflowDefinitionReference - a reference to the workflow definition to start

documentId - the id of the document to start the process on

actors - a list of the receivers of the next task, may be null depending on the workflow definition

comment - a comment for the workflow process, may be null depending on the workflow definition

Returns:

a reference to the process that was started.

Throws:

EcmException

getInitialTransition

TransitionDefinitionType getInitialTransition(WorkflowDefinitionReferenceType reference)
                                       throws EcmException

This method returns the initial transition definition for the referenced workflow. If the referenced workflow definition doesn't exist the method throws a ResourceNotFoundException. If the initial transition was not found the method returns null.

Parameters:

reference - the workflow definition reference

Returns:

the initial transition of the referenced workflow or null if not present

Throws:

EcmException