com.saperion.workflow

Interface WorkflowTaskService

All Known Implementing Classes:

RmiClientWorkflowTaskService

public interface WorkflowTaskService

This component is injectable to operations and provides functionality concerning workflow tasks.

Author:

cmerkel

Method Summary

Methods

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

Method Detail

acquireOwnership

void acquireOwnership(com.lexmark.saperion.workflow.TaskReferenceType taskReference,
                    boolean sync,
                    int workingTime,
                    String comment)
                      throws SaAuthenticationException,
                             SaSystemException

Acquires the ownership of a task.

Parameters:

taskReference - the reference to the task

sync - wait for the workflow operation to complete or not

workingTime - working time for the current step for statistics

Throws:

SaAuthenticationException - authentication exception

SaSystemException - system exception

acquireOwnership

void acquireOwnership(com.lexmark.saperion.workflow.TaskReferenceType taskReference,
                    String comment)
                      throws SaAuthenticationException,
                             SaSystemException

Acquires the ownership of a task.

Parameters:

taskReference - the reference to the task

Throws:

SaAuthenticationException - authentication exception

SaSystemException - system exception

addComment

void addComment(com.lexmark.saperion.workflow.TaskReferenceType taskReference,
              String comment,
              int level)
                throws SaAuthenticationException,
                       SaSystemException

Adds a comment to a workflow task.

Parameters:

taskReference - the reference to the task

comment - the comment to add

level - the level to add the comment to

Throws:

SaAuthenticationException - authentication exception

SaSystemException - system exception

addComment

void addComment(com.lexmark.saperion.workflow.TaskReferenceType taskReference,
              String comment)
                throws SaAuthenticationException,
                       SaSystemException

Adds a comment to a workflow task.

Parameters:

taskReference - the reference to the task

comment - the comment to add

Throws:

SaAuthenticationException - authentication exception

SaSystemException - system exception

forward

void forward(com.lexmark.saperion.workflow.TaskReferenceType taskReference,
           int transitionId,
           List<com.lexmark.saperion.administration.ActorReferenceType> recipients,
           String comment,
           boolean sync,
           int workingTime)
             throws SaSystemException,
                    SaAuthenticationException

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

workingTime - working time for the current step for statistics

Throws:

SaSystemException - system exception

SaAuthenticationException - authentication exception

forward

void forward(com.lexmark.saperion.workflow.TaskReferenceType taskReference,
           int transitionId,
           List<com.lexmark.saperion.administration.ActorReferenceType> recipients,
           String comment)
             throws SaSystemException,
                    SaAuthenticationException

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

Throws:

SaSystemException - system exception

SaAuthenticationException - authentication exception

getIndexData

List<com.lexmark.saperion.PropertyType> getIndexData(com.lexmark.saperion.workflow.TaskReferenceType taskReference)
                                                     throws SaAuthenticationException,
                                                            SaSystemException

Returns the task's index data.

Parameters:

taskReference - the reference to the task

Returns:

the task's index data

Throws:

SaAuthenticationException - authentication exception

SaSystemException

getProperties

com.lexmark.saperion.workflow.TaskType getProperties(com.lexmark.saperion.workflow.TaskReferenceType taskReference)
                                                     throws SaAuthenticationException,
                                                            SaSystemException

Returns the task's properties.

Parameters:

taskReference - the reference to the task

Returns:

the task's properties

Throws:

SaAuthenticationException - authentication exception

SaSystemException - system exception

getComments

List<com.lexmark.saperion.workflow.TaskCommentType> getComments(com.lexmark.saperion.workflow.TaskReferenceType taskReference)
                                                                throws SaAuthenticationException,
                                                                       SaSystemException

Returns the task's comments.

Parameters:

taskReference - the reference to the task

Returns:

the task's comments

Throws:

SaAuthenticationException - authentication exception

SaSystemException - system exception

getTransitions

List<com.lexmark.saperion.workflow.TransitionDefinitionType> getTransitions(com.lexmark.saperion.workflow.TaskReferenceType taskReference)
                                                                            throws SaAuthenticationException,
                                                                                   SaSystemException

Returns the task's transition definitions.

Parameters:

taskReference - the reference to the task

Returns:

the task's transition definitions

Throws:

SaAuthenticationException - authentication exception

SaSystemException - system exception

revokeOwnership

void revokeOwnership(com.lexmark.saperion.workflow.TaskReferenceType taskReference,
                   boolean sync,
                   int workingTime,
                   String comment)
                     throws SaAuthenticationException,
                            SaSystemException

Revokes the ownership of a task.

Parameters:

taskReference - the reference to the task

sync - wait for the workflow operation to complete or not

workingTime - working time for the current step for statistics

comment - the comment that will be shown in the history

Throws:

SaAuthenticationException - authentication exception

SaSystemException - system exception

revokeOwnership

void revokeOwnership(com.lexmark.saperion.workflow.TaskReferenceType taskReference,
                   String comment)
                     throws SaAuthenticationException,
                            SaSystemException

Revokes the ownership of a task.

Parameters:

taskReference - the reference to the task

comment - the comment that will be shown in the history

Throws:

SaAuthenticationException - authentication exception

SaSystemException - system exception

updateIndexData

void updateIndexData(com.lexmark.saperion.workflow.TaskReferenceType taskReference,
                   List<com.lexmark.saperion.PropertyType> properties,
                   String comment)
                     throws SaAuthenticationException,
                            SaSystemException

Updates the task's index data.

Parameters:

taskReference - the reference to the task

properties - the task's index data

comment - the comment for the new revision

Throws:

SaAuthenticationException - authentication exception

SaSystemException - system exception