com.lexmark.saperion.workflow

Interface WorkflowTaskService

public interface WorkflowTaskService

This service provides functionality concerning workflow tasks.

Author:

cmerkel

Method Summary

Modifier and Type	Method and Description
void	acquireOwnership(TaskReferenceType taskReference) Acquires the ownership of a task.
void	addComment(TaskReferenceType taskReference, String comment) Adds a comment to a workflow task.
void	forward(TaskReferenceType taskReference, int transitionId, List<ActorReferenceType> recipients, String comment, boolean sync) Finishes the task execution and forwards the workflow to the next step.
List<TaskCommentType>	getComments(TaskReferenceType taskReference) Returns the task's comments.
Map<String,PropertyType>	getIndexData(TaskReferenceType taskReference) Returns the task's index data.
TaskType	getProperties(TaskReferenceType taskReference) Returns the task's properties.
List<TransitionDefinitionType>	getTransitions(TaskReferenceType taskReference) Returns the task's transition definitions.
void	revokeOwnership(TaskReferenceType taskReference) Revokes the ownership of a task.
void	updateIndexData(TaskReferenceType taskReference, Map<String,PropertyType> properties) Updates the task's index data.

Method Detail

acquireOwnership

void acquireOwnership(TaskReferenceType taskReference)
               throws EcmException

Acquires the ownership of a task.

Parameters:

taskReference - the reference to the task

Throws:

EcmException

addComment

void addComment(TaskReferenceType taskReference,
                String comment)
         throws EcmException

Adds a comment to a workflow task.

Parameters:

taskReference - the reference to the task

comment - the comment to add

Throws:

EcmException

forward

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

Finishes the task execution and forwards the workflow to the next step.

Parameters:

taskReference - the reference to the task

transitionId - the ID of the next transition to use when forwarding

recipients - the recipients of the next step if required

comment - the comment that will be shown in the history

sync - wait for the workflow operation to complete or not

Throws:

EcmException

getIndexData

Map<String,PropertyType> getIndexData(TaskReferenceType taskReference)
                               throws EcmException

Returns the task's index data.

Parameters:

taskReference - the reference to the task

Returns:

the task's index data

Throws:

EcmException

getProperties

TaskType getProperties(TaskReferenceType taskReference)
                throws EcmException

Returns the task's properties.

Parameters:

taskReference - the reference to the task

Returns:

the task's properties

Throws:

EcmException

getComments

List<TaskCommentType> getComments(TaskReferenceType taskReference)
                           throws EcmException

Returns the task's comments.

Parameters:

taskReference - the reference to the task

Returns:

the task's comments

Throws:

EcmException

getTransitions

List<TransitionDefinitionType> getTransitions(TaskReferenceType taskReference)
                                       throws EcmException

Returns the task's transition definitions.

Parameters:

taskReference - the reference to the task

Returns:

the task's transition definitions

Throws:

EcmException

revokeOwnership

void revokeOwnership(TaskReferenceType taskReference)
              throws EcmException

Revokes the ownership of a task.

Parameters:

taskReference - the reference to the task

Throws:

EcmException

updateIndexData

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

Updates the task's index data.

Parameters:

taskReference - the reference to the task

properties - the task's index data

Throws:

EcmException