Package com.lexmark.saperion.client.implementation.workflow

Class WorkflowDefinitionClientImpl

java.lang.Object

com.lexmark.saperion.client.implementation.workflow.WorkflowDefinitionClientImpl

All Implemented Interfaces:

WorkflowDefinitionClient

public class WorkflowDefinitionClientImpl
extends Object
implements WorkflowDefinitionClient

This is the default implementation of WorkflowDefinitionClient.

Author:

jschwarz

Constructor Summary

Constructors

Constructor	Description
WorkflowDefinitionClientImpl(WorkflowDefinitionService workflowDefinitionService, WorkflowDefinitionReferenceType reference)

Method Summary

Modifier and Type	Method	Description
TransitionDefinitionType	getInitialTransition()	This method returns the initial transition definition for the workflow definition.
WorkflowDefinitionType	load()	This method returns a representation of the workflow definition.
WorkflowProcessReferenceType	startWorkflow(com.lexmark.saperion.document.DocumentReferenceType document, String comment, List<com.lexmark.saperion.administration.ActorReferenceType> actors)	This method starts a workflow for the given document.

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.client.workflow.WorkflowDefinitionClient

startWorkflow

Constructor Details

WorkflowDefinitionClientImpl

public WorkflowDefinitionClientImpl(WorkflowDefinitionService workflowDefinitionService,
 WorkflowDefinitionReferenceType reference)

Method Details

load

public WorkflowDefinitionType load()
                            throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowDefinitionClient

This method returns a representation of the workflow definition.

Specified by:

load in interface WorkflowDefinitionClient

Returns:

the workflow definition representation.

Throws:

com.lexmark.saperion.exceptions.system.SystemException - indicates that a system exception occurred

com.lexmark.saperion.exceptions.EcmException

getInitialTransition

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

Description copied from interface: WorkflowDefinitionClient

This method returns the initial transition definition for the workflow definition. The initial transition definition contains additional information which input must be provided in order to start a workflow process.

Specified by:

getInitialTransition in interface WorkflowDefinitionClient

Returns:

the initial transition definition

Throws:

com.lexmark.saperion.exceptions.system.SystemException - indicates that a system exception occurred

com.lexmark.saperion.exceptions.EcmException

startWorkflow

public WorkflowProcessReferenceType startWorkflow(com.lexmark.saperion.document.DocumentReferenceType document,
 String comment,
 List<com.lexmark.saperion.administration.ActorReferenceType> actors)
                                           throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowDefinitionClient

This method starts a workflow for the given document.

Specified by:

startWorkflow in interface WorkflowDefinitionClient

Parameters:

document - the document for which the workflow is started.

comment - the workflow start comment

actors - list of actors for the next workflow step

Returns:

a reference to the new process

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred