com.lexmark.saperion.client.implementation.workflow

Class WorkflowServiceClientImpl

java.lang.Object

com.lexmark.saperion.client.implementation.workflow.WorkflowServiceClientImpl

All Implemented Interfaces:

WorkflowServiceClient

public class WorkflowServiceClientImpl
extends Object
implements WorkflowServiceClient

This is the default implementation of WorkflowServiceClient.

Author:

jschwarz

Constructor Summary

Constructors

Constructor and Description
WorkflowServiceClientImpl(WorkflowDefinitionService workflowDefinitionService, WorkflowInboxService workflowInboxService, WorkflowProcessService workflowProcessService, WorkflowTaskService workflowTaskService)

Method Summary

Modifier and Type	Method and Description
WorkflowInboxServiceClient	getInboxClient() This method returns a client offering functionality concerning workflow inboxes.
WorkflowTaskClient	getTask(TaskReferenceType reference) This method returns a client for the workflow task with the provided id.
WorkflowDefinitionClient	getWorkflowDefinition(String definition) This method returns a client for the definition with the given name.
WorkflowDefinitionClient	getWorkflowDefinition(WorkflowDefinitionReferenceType reference) This method returns a client for the workflow definition with the provided id.
SearchClient<WorkflowProcessListItemType>	getWorkflowProcesses() This method returns a search client for the workflow processes in the system.
WorkflowProcessType	loadWorkflowProcess(WorkflowProcessReferenceType workflowReference) This method loads a workflow process.
SearchClient<WorkflowDefinitionListItemType>	searchWorkflowDefinitions() This method returns a resource client for the workflow definition collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowServiceClientImpl

public WorkflowServiceClientImpl(WorkflowDefinitionService workflowDefinitionService,
                                 WorkflowInboxService workflowInboxService,
                                 WorkflowProcessService workflowProcessService,
                                 WorkflowTaskService workflowTaskService)

Method Detail

getTask

public WorkflowTaskClient getTask(TaskReferenceType reference)

Description copied from interface: WorkflowServiceClient

This method returns a client for the workflow task with the provided id.

Specified by:

getTask in interface WorkflowServiceClient

Parameters:

reference - the task id

Returns:

a resource client for the workflow task with the provided id

getWorkflowDefinition

public WorkflowDefinitionClient getWorkflowDefinition(String definition)
                                               throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowServiceClient

This method returns a client for the definition with the given name.

Specified by:

getWorkflowDefinition in interface WorkflowServiceClient

Parameters:

definition - the definition name

Returns:

the matching definition

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates an arbitrary system error

getWorkflowDefinition

public WorkflowDefinitionClient getWorkflowDefinition(WorkflowDefinitionReferenceType reference)

Description copied from interface: WorkflowServiceClient

This method returns a client for the workflow definition with the provided id.

Specified by:

getWorkflowDefinition in interface WorkflowServiceClient

Parameters:

reference - the workflow definition id

Returns:

a resource client for the workflow definition with the provided id

searchWorkflowDefinitions

public SearchClient<WorkflowDefinitionListItemType> searchWorkflowDefinitions()

Description copied from interface: WorkflowServiceClient

This method returns a resource client for the workflow definition collection. The client can be used to search the workflow definition and list its contents.

Specified by:

searchWorkflowDefinitions in interface WorkflowServiceClient

Returns:

a client for the workflow definition collection

getInboxClient

public WorkflowInboxServiceClient getInboxClient()

Description copied from interface: WorkflowServiceClient

This method returns a client offering functionality concerning workflow inboxes.

Specified by:

getInboxClient in interface WorkflowServiceClient

Returns:

a client offering functionality concerning workflow inboxes

loadWorkflowProcess

public WorkflowProcessType loadWorkflowProcess(WorkflowProcessReferenceType workflowReference)
                                        throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowServiceClient

This method loads a workflow process.

Specified by:

loadWorkflowProcess in interface WorkflowServiceClient

Parameters:

workflowReference - a reference to the workflow process to load

Returns:

the workflow process

Throws:

com.lexmark.saperion.exceptions.EcmException

getWorkflowProcesses

public SearchClient<WorkflowProcessListItemType> getWorkflowProcesses()

Description copied from interface: WorkflowServiceClient

This method returns a search client for the workflow processes in the system.

Specified by:

getWorkflowProcesses in interface WorkflowServiceClient

Returns:

the workflow process resource collection