Package com.lexmark.saperion.delegate

Class AbstractWorkflowTaskDelegateService

java.lang.Object

com.lexmark.saperion.delegate.AbstractDelegateService<WorkflowTaskService>

com.lexmark.saperion.delegate.AbstractWorkflowTaskDelegateService

All Implemented Interfaces:

WorkflowTaskService

Direct Known Subclasses:

WorkflowTaskDelegateService

public abstract class AbstractWorkflowTaskDelegateService
extends AbstractDelegateService<WorkflowTaskService>
implements WorkflowTaskService

This WorkflowTaskService simply delegates to another instance.

Author:

jschwarz

Constructor Summary

Constructors

Constructor	Description
AbstractWorkflowTaskDelegateService()

Method Summary

Modifier and Type	Method	Description
void	acquireOwnership(TaskReferenceType taskReference)	Acquires the ownership of a task.
void	addComment(TaskReferenceType taskReference, java.lang.String comment)	Adds a comment to a workflow task.
TaskType	createReminderForTask(TaskReferenceType taskReferenceType, long date)	Creates reminder for the given task
void	forward(TaskReferenceType taskReference, TaskForwardInputType forwardInput)	Finishes the task execution and forwards the workflow to the next step.
java.util.List<TaskCommentType>	getComments(TaskReferenceType taskReference)	Returns the task's comments.
java.util.Map<java.lang.String,com.lexmark.saperion.PropertyType>	getIndexData(TaskReferenceType taskReference)	Returns the task's index data.
java.util.List<TaskType>	getOverdueTasks()	Returns list of tasks that are passed their due date
java.util.List<TaskType>	getOwnedTasks()	Returns tasks that owned by requester
TaskType	getProperties(TaskReferenceType taskReference)	Returns the task's properties.
java.util.List<TaskType>	getTasksWithReminder()	Returns workflow tasks that has reminder
java.util.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, java.util.Map<java.lang.String,com.lexmark.saperion.PropertyType> properties)	Updates the task's index data.
TaskType	updateReminderForTask(TaskReferenceType taskReferenceType, long date)	Update or reset reminder for a given task.

Methods inherited from class com.lexmark.saperion.delegate.AbstractDelegateService

getDelegate, wrapSearchExecutionService

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.workflow.WorkflowTaskService

forward

Constructor Detail

AbstractWorkflowTaskDelegateService

public AbstractWorkflowTaskDelegateService()

Method Detail

acquireOwnership

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

Description copied from interface: WorkflowTaskService

Acquires the ownership of a task.

Specified by:

acquireOwnership in interface WorkflowTaskService

Parameters:

taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}

Throws:

com.lexmark.saperion.exceptions.EcmException

addComment

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

Description copied from interface: WorkflowTaskService

Adds a comment to a workflow task.

Specified by:

addComment in interface WorkflowTaskService

Parameters:

taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}

comment - the comment to add

Throws:

com.lexmark.saperion.exceptions.EcmException

forward

public void forward(TaskReferenceType taskReference,
                    TaskForwardInputType forwardInput)
             throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowTaskService

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

Specified by:

forward in interface WorkflowTaskService

Parameters:

taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}

forwardInput - the parameters for forwarding

Throws:

com.lexmark.saperion.exceptions.EcmException

getIndexData

public java.util.Map<java.lang.String,com.lexmark.saperion.PropertyType> getIndexData(TaskReferenceType taskReference)
                                                                                     throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowTaskService

Returns the task's index data.

Specified by:

getIndexData in interface WorkflowTaskService

Parameters:

taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}

Returns:

the task's index data

Throws:

com.lexmark.saperion.exceptions.EcmException

getProperties

public TaskType getProperties(TaskReferenceType taskReference)
                       throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: WorkflowTaskService

Returns the task's properties.

Specified by:

getProperties in interface WorkflowTaskService

Parameters:

taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}

Returns:

the task's properties

Throws:

com.lexmark.saperion.exceptions.EcmException

getComments

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

Description copied from interface: WorkflowTaskService

Returns the task's comments.

Specified by:

getComments in interface WorkflowTaskService

Parameters:

taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}

Returns:

the task's comments

Throws:

com.lexmark.saperion.exceptions.EcmException

getTransitions

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

Description copied from interface: WorkflowTaskService

Returns the task's transition definitions.

Specified by:

getTransitions in interface WorkflowTaskService

Parameters:

taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}

Returns:

the task's transition definitions

Throws:

com.lexmark.saperion.exceptions.EcmException

revokeOwnership

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

Description copied from interface: WorkflowTaskService

Revokes the ownership of a task.

Specified by:

revokeOwnership in interface WorkflowTaskService

Parameters:

taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}

Throws:

com.lexmark.saperion.exceptions.EcmException

updateIndexData

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

Description copied from interface: WorkflowTaskService

Updates the task's index data.

Specified by:

updateIndexData in interface WorkflowTaskService

Parameters:

taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}

properties - the task's index data

Throws:

com.lexmark.saperion.exceptions.EcmException

getTasksWithReminder

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

Description copied from interface: WorkflowTaskService

Returns workflow tasks that has reminder

Specified by:

getTasksWithReminder in interface WorkflowTaskService

Returns:

List of tasks

Throws:

com.lexmark.saperion.exceptions.EcmException

getOwnedTasks

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

Description copied from interface: WorkflowTaskService

Returns tasks that owned by requester

Specified by:

getOwnedTasks in interface WorkflowTaskService

Returns:

Throws:

com.lexmark.saperion.exceptions.EcmException

getOverdueTasks

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

Description copied from interface: WorkflowTaskService

Returns list of tasks that are passed their due date

Specified by:

getOverdueTasks in interface WorkflowTaskService

Returns:

Throws:

com.lexmark.saperion.exceptions.EcmException

createReminderForTask

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

Description copied from interface: WorkflowTaskService

Creates reminder for the given task

Specified by:

createReminderForTask in interface WorkflowTaskService

Returns:

Throws:

com.lexmark.saperion.exceptions.EcmException

updateReminderForTask

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

Description copied from interface: WorkflowTaskService

Update or reset reminder for a given task.

Specified by:

updateReminderForTask in interface WorkflowTaskService

Returns:

Throws:

com.lexmark.saperion.exceptions.EcmException