com.saperion.workflow

Interface WorkflowDefinitionService

All Known Implementing Classes:

RmiClientWorkflowDefinitionService

public interface WorkflowDefinitionService

This component is injectable to operations and provides functionality concerning workflow definitions.

Author:

jschwarz

Method Summary

Methods

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

Method Detail

listWorkflowDefinitions

List<com.lexmark.saperion.workflow.WorkflowDefinitionListItemType> listWorkflowDefinitions()
                                                                                           throws NativeException,
                                                                                                  SaAuthenticationException

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

Returns:

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

Throws:

NativeException

SaAuthenticationException

getWorkflowDefinitionById

com.lexmark.saperion.workflow.WorkflowDefinitionType getWorkflowDefinitionById(com.lexmark.saperion.workflow.WorkflowDefinitionReferenceType reference)
                                                                               throws SaBasicException

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:

SaBasicException

startWorkflowProcess

com.lexmark.saperion.workflow.WorkflowProcessReferenceType startWorkflowProcess(com.lexmark.saperion.workflow.WorkflowDefinitionReferenceType workflowDefinitionReference,
                                                                              com.lexmark.saperion.document.DocumentReferenceType documentId,
                                                                              List<? extends com.lexmark.saperion.administration.ActorReferenceType> actors,
                                                                              String comment)
                                                                                throws SaBasicException

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:

SaBasicException

getInitialTransition

com.lexmark.saperion.workflow.TransitionDefinitionType getInitialTransition(com.lexmark.saperion.workflow.WorkflowDefinitionReferenceType reference)
                                                                            throws SaBasicException

This method returns the initial transition definition for the referenced workflow. If the referenced workflow definition doesn't exist the method throws an UnknownReferenceException. 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:

UnknownReferenceException - the referenced workflow definition does not exist

SaBasicException