com.lexmark.saperion.client.workflow

Interface WorkflowTaskClient

All Known Implementing Classes:

WorkflowTaskClientImpl

public interface WorkflowTaskClient

This client provides functionality for a given workflow task.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
void	acquireOwnership() This method acquires the ownership of the task for the current user.
void	addComment(String comment) This method adds a comment to the workflow task.
void	forward() This method forwards a task.
void	forward(int transitionId) This method finishes the task execution and forwards the workflow to the next step.
void	forward(int transitionId, List<ActorReferenceType> recipients, String comment) This method finishes the task execution and forwards the workflow to the next step.
void	forward(int transitionId, List<ActorReferenceType> recipients, String comment, boolean sync) This method finishes the task execution and forwards the workflow to the next step.
void	forward(List<ActorReferenceType> recipients) This method finishes the task execution and forwards the workflow to the next step.
List<TaskCommentType>	getComments() This method returns the task's comments.
List<TransitionDefinitionType>	getTransitions() This method returns the task's forward transition definitions.
TaskType	load() This method returns the task's properties.
void	revokeOwnership() This method revokes the ownership of the task from the current user.
void	updateIndexData(Map<String,PropertyType> properties) This method updates the task's index data.

Method Detail

acquireOwnership

void acquireOwnership()
               throws EcmException

This method acquires the ownership of the task for the current user.

Throws:

EcmException - indicates that a system exception occurred

addComment

void addComment(String comment)
         throws EcmException

This method adds a comment to the workflow task.

Parameters:

comment - the comment

Throws:

SystemException - indicates that a system exception occurred

EcmException

forward

void forward(int transitionId,
             List<ActorReferenceType> recipients,
             String comment,
             boolean sync)
      throws EcmException

This method finishes the task execution and forwards the workflow to the next step.

Throws:

EcmException - indicates that a system exception occurred

forward

void forward(int transitionId,
             List<ActorReferenceType> recipients,
             String comment)
      throws EcmException

This method finishes the task execution and forwards the workflow to the next step.

Throws:

EcmException - indicates that a system exception occurred

forward

void forward(List<ActorReferenceType> recipients)
      throws EcmException

This method finishes the task execution and forwards the workflow to the next step.

Throws:

EcmException - indicates that a system exception occurred

forward

void forward(int transitionId)
      throws EcmException

This method finishes the task execution and forwards the workflow to the next step.

Throws:

EcmException - indicates that a system exception occurred

forward

void forward()
      throws EcmException

This method forwards a task. The transition is determined by the server.

Throws:

EcmException - indicates that a system exception occurred

load

TaskType load()
       throws EcmException

This method returns the task's properties.

Returns:

the task's properties

Throws:

EcmException - indicates that a system exception occurred

getComments

List<TaskCommentType> getComments()
                           throws EcmException

This method returns the task's comments.

Returns:

the task's comments

Throws:

EcmException - indicates that a system exception occurred

getTransitions

List<TransitionDefinitionType> getTransitions()
                                       throws EcmException

This method returns the task's forward transition definitions.

Returns:

the task's forward transition definitions

Throws:

EcmException - indicates that a system exception occurred

revokeOwnership

void revokeOwnership()
              throws EcmException

This method revokes the ownership of the task from the current user.

Throws:

EcmException - indicates that a system exception occurred

updateIndexData

void updateIndexData(Map<String,PropertyType> properties)
              throws EcmException

This method updates the task's index data.

Parameters:

properties - the task's index data

Throws:

EcmException - indicates that a system exception occurred