com.lexmark.saperion.client.workflow

Interface WorkflowServiceClient

All Known Implementing Classes:

WorkflowServiceClientImpl

public interface WorkflowServiceClient

This client provides functionality and services concerning workflow.

Author:

jschwarz

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.

Method Detail

getTask

WorkflowTaskClient getTask(TaskReferenceType reference)

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

Parameters:

reference - the task id

Returns:

a resource client for the workflow task with the provided id

getWorkflowDefinition

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

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

Parameters:

definition - the definition name

Returns:

the matching definition

Throws:

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

getWorkflowDefinition

WorkflowDefinitionClient getWorkflowDefinition(WorkflowDefinitionReferenceType reference)

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

Parameters:

reference - the workflow definition id

Returns:

a resource client for the workflow definition with the provided id

searchWorkflowDefinitions

SearchClient<WorkflowDefinitionListItemType> searchWorkflowDefinitions()

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.

Returns:

a client for the workflow definition collection

getInboxClient

WorkflowInboxServiceClient getInboxClient()

This method returns a client offering functionality concerning workflow inboxes.

Returns:

a client offering functionality concerning workflow inboxes

loadWorkflowProcess

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

This method loads a workflow process.

Parameters:

workflowReference - a reference to the workflow process to load

Returns:

the workflow process

Throws:

com.lexmark.saperion.exceptions.EcmException

getWorkflowProcesses

SearchClient<WorkflowProcessListItemType> getWorkflowProcesses()

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

Returns:

the workflow process resource collection