Package com.lexmark.saperion.client.implementation.workflow

Class WorkflowTaskClientImpl

java.lang.Object

com.lexmark.saperion.client.implementation.workflow.WorkflowTaskClientImpl

All Implemented Interfaces:

WorkflowTaskClient

public class WorkflowTaskClientImpl
extends java.lang.Object
implements WorkflowTaskClient

This is the default implementation of WorkflowTaskClient.

Author:

jschwarz

Constructor Summary

Constructors

Constructor	Description
WorkflowTaskClientImpl(WorkflowTaskService workflowTaskService)
WorkflowTaskClientImpl(WorkflowTaskService workflowTaskService, TaskReferenceType reference)

Method Summary

Modifier and Type	Method	Description
void	acquireOwnership()	This method acquires the ownership of the task for the current user.
void	addComment(java.lang.String comment)	This method adds a comment to the workflow task.
TaskType	createReminderForTask(long date)	Creates reminder for given task
void	forward(int transitionId, java.util.List<com.lexmark.saperion.administration.ActorReferenceType> recipients, java.lang.String comment, boolean sync)	This method finishes the task execution and forwards the workflow to the next step.
java.util.List<TaskCommentType>	getComments()	This method returns the task's comments.
java.util.List<TaskType>	getOverdueTasks()	Returns tasks that owned by requester
java.util.List<TaskType>	getOwnedTasks()	Returns List of tasks that are owned by requester
java.util.List<TaskType>	getTasksWithReminder()	Returns List of tasks that have reminders set
java.util.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(java.util.Map<java.lang.String,com.lexmark.saperion.PropertyType> properties)	This method updates the task's index data.
TaskType	updateReminderForTask(long date)	Update or reset reminder for a given task.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.lexmark.saperion.client.workflow.WorkflowTaskClient

forward, forward, forward, forward

Constructor Detail

WorkflowTaskClientImpl

public WorkflowTaskClientImpl(WorkflowTaskService workflowTaskService,
                              TaskReferenceType reference)

WorkflowTaskClientImpl

public WorkflowTaskClientImpl(WorkflowTaskService workflowTaskService)

Method Detail

acquireOwnership

public void acquireOwnership()
                      throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowTaskClient

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

Specified by:

acquireOwnership in interface WorkflowTaskClient

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

addComment

public void addComment(java.lang.String comment)
                throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowTaskClient

This method adds a comment to the workflow task.

Specified by:

addComment in interface WorkflowTaskClient

Parameters:

comment - the comment

Throws:

com.lexmark.saperion.exceptions.system.SystemException - indicates that a system exception occurred

com.lexmark.saperion.exceptions.EcmException

forward

public void forward(int transitionId,
                    java.util.List<com.lexmark.saperion.administration.ActorReferenceType> recipients,
                    java.lang.String comment,
                    boolean sync)
             throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowTaskClient

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

Specified by:

forward in interface WorkflowTaskClient

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

load

public TaskType load()
              throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowTaskClient

This method returns the task's properties.

Specified by:

load in interface WorkflowTaskClient

Returns:

the task's properties

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

getComments

public java.util.List<TaskCommentType> getComments()
                                            throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowTaskClient

This method returns the task's comments.

Specified by:

getComments in interface WorkflowTaskClient

Returns:

the task's comments

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

getTransitions

public java.util.List<TransitionDefinitionType> getTransitions()
                                                        throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowTaskClient

This method returns the task's forward transition definitions.

Specified by:

getTransitions in interface WorkflowTaskClient

Returns:

the task's forward transition definitions

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

revokeOwnership

public void revokeOwnership()
                     throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowTaskClient

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

Specified by:

revokeOwnership in interface WorkflowTaskClient

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

updateIndexData

public void updateIndexData(java.util.Map<java.lang.String,com.lexmark.saperion.PropertyType> properties)
                     throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowTaskClient

This method updates the task's index data.

Specified by:

updateIndexData in interface WorkflowTaskClient

Parameters:

properties - the task's index data

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

getTasksWithReminder

public java.util.List<TaskType> getTasksWithReminder()
                                              throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowTaskClient

Returns List of tasks that have reminders set

Specified by:

getTasksWithReminder in interface WorkflowTaskClient

Returns:

Throws:

com.lexmark.saperion.exceptions.EcmException

getOwnedTasks

public java.util.List<TaskType> getOwnedTasks()
                                       throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowTaskClient

Returns List of tasks that are owned by requester

Specified by:

getOwnedTasks in interface WorkflowTaskClient

Returns:

Throws:

com.lexmark.saperion.exceptions.EcmException

getOverdueTasks

public java.util.List<TaskType> getOverdueTasks()
                                         throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowTaskClient

Returns tasks that owned by requester

Specified by:

getOverdueTasks in interface WorkflowTaskClient

Returns:

Throws:

com.lexmark.saperion.exceptions.EcmException

createReminderForTask

public TaskType createReminderForTask(long date)
                               throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowTaskClient

Creates reminder for given task

Specified by:

createReminderForTask in interface WorkflowTaskClient

Returns:

Throws:

com.lexmark.saperion.exceptions.EcmException

updateReminderForTask

public TaskType updateReminderForTask(long date)
                               throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowTaskClient

Update or reset reminder for a given task.

Specified by:

updateReminderForTask in interface WorkflowTaskClient

Returns:

Throws:

com.lexmark.saperion.exceptions.EcmException