Package com.lexmark.saperion.delegate

Class AbstractWorkflowDefinitionDelegateService

java.lang.Object

com.lexmark.saperion.delegate.AbstractDelegateService<WorkflowDefinitionService>

com.lexmark.saperion.delegate.AbstractWorkflowDefinitionDelegateService

All Implemented Interfaces:

com.lexmark.saperion.search.SearchExecutionService<WorkflowDefinitionListItemType>, WorkflowDefinitionService

Direct Known Subclasses:

WorkflowDefinitionDelegateService

public abstract class AbstractWorkflowDefinitionDelegateService
extends AbstractDelegateService<WorkflowDefinitionService>
implements WorkflowDefinitionService

This WorkflowDefinitionService simply delegates to another instance.

Author:

jschwarz

Constructor Summary

Constructors

Constructor	Description
AbstractWorkflowDefinitionDelegateService()

Method Summary

Modifier and Type	Method	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.
com.lexmark.saperion.search.SearchResultPage<WorkflowDefinitionListItemType>	search(com.lexmark.saperion.search.query.Statement statement, com.lexmark.saperion.search.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, WorkflowStartInputType input)	This method starts a workflow process given a workflow definition and a document (by its id).

Methods inherited from class com.lexmark.saperion.delegate.AbstractDelegateService

getDelegate, wrapSearchExecutionService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.lexmark.saperion.workflow.WorkflowDefinitionService

startWorkflowProcess

Constructor Detail

AbstractWorkflowDefinitionDelegateService

public AbstractWorkflowDefinitionDelegateService()

Method Detail

search

public com.lexmark.saperion.search.SearchResultPage<WorkflowDefinitionListItemType> search(com.lexmark.saperion.search.query.Statement statement,
                                                                                           com.lexmark.saperion.search.PageDefinition pageDefinition)
                                                                                    throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowDefinitionService

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

Specified by:

search in interface com.lexmark.saperion.search.SearchExecutionService<WorkflowDefinitionListItemType>

Specified by:

search in interface WorkflowDefinitionService

Returns:

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

Throws:

com.lexmark.saperion.exceptions.EcmException

getWorkflowDefinitionById

public WorkflowDefinitionType getWorkflowDefinitionById(WorkflowDefinitionReferenceType reference)
                                                 throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowDefinitionService

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

Specified by:

getWorkflowDefinitionById in interface WorkflowDefinitionService

Parameters:

reference - the workflow definition reference in base64 encoded form of {"name":"xxx"}

Returns:

further information for a workflow process given by its reference

Throws:

com.lexmark.saperion.exceptions.EcmException

startWorkflowProcess

public WorkflowProcessReferenceType startWorkflowProcess(WorkflowDefinitionReferenceType workflowDefinitionReference,
                                                         WorkflowStartInputType input)
                                                  throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowDefinitionService

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

Specified by:

startWorkflowProcess in interface WorkflowDefinitionService

Parameters:

workflowDefinitionReference - the workflow definition reference in base64 encoded form of {"name":"xxx"}

input - the parameters for starting a workflow

Returns:

a reference to the process that was started.

Throws:

com.lexmark.saperion.exceptions.EcmException

getInitialTransition

public TransitionDefinitionType getInitialTransition(WorkflowDefinitionReferenceType reference)
                                              throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowDefinitionService

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.

Specified by:

getInitialTransition in interface WorkflowDefinitionService

Parameters:

reference - the workflow definition reference in base64 encoded form of {"name":"xxx"}

Returns:

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

Throws:

com.lexmark.saperion.exceptions.EcmException