Package com.aquima.interactions.process.impl

Class ProcessTaskDefinition

java.lang.Object

com.aquima.interactions.process.impl.ProcessTaskDefinition

All Implemented Interfaces:

IProcessTaskDefinition

public class ProcessTaskDefinition
extends Object
implements IProcessTaskDefinition

This class contains a single process task definition.

Since:

7.1

Author:

O. Kerpershoek

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProcessTaskDefinition(IProcessTaskDS datasource, IProject project, IExpressionParser parser, IProcessEngine processEngine)

Method Summary

Modifier and Type	Method	Description
IAuthorizationAlgorithmDefinition	getAuthorizationAlgorithm()	This method returns the authorization algorithm.
IProcessTaskCustomField[]	getCustomFields()	Gets the custom fields which are stored on this task.
String	getDescription()	This method returns a description of the process task definition.
IMultilingualText	getDisplayName()	This method returns a text object containing the name that should be used for display purposes.
IExpression	getDueDate()	Gets the expression that determines the date on which this task should be ended.
TaskExit[]	getExitStates()	This method returns an array containing the possible exit states of the task.
GUID	getId()	This method returns the unique identifier of the task definition.
String	getName()	This method returns the (unique) name of the task definition.
IPriorityAlgorithmDefinition	getPriorityAlgorithm()	This method returns the priority algorithm.
ReevaluationEvent	getReevaluationEvent()	This method returns the reevaluation event
IExpression	getRetryCountExpression()	This method returns the expression that should be evaluated for automatic tasks to determine the number of times the task should be retried in case of failure.
long	getRetryInterval()	This method returns the interval in minutes the automatic task should wait before a failed task should be attempted again.
IRole[]	getRoles()	This method returns an array containing the roles that allow a user to execute the task.
IRoutingAlgorithmDefinition	getRoutingAlgorithm()	This method returns the routing algorithm.
boolean	isAutomatic()	This method returns a boolean indicating if the task is an automated task, and thus should be handled by the system in stead of a user.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessTaskDefinition

protected ProcessTaskDefinition(IProcessTaskDS datasource,
                                IProject project,
                                IExpressionParser parser,
                                IProcessEngine processEngine)
                         throws InitializationException

Throws:

InitializationException

Method Detail

getId

public GUID getId()

Description copied from interface: IProcessTaskDefinition

This method returns the unique identifier of the task definition.

Specified by:

getId in interface IProcessTaskDefinition

Returns:

the unique identifier of the task definition.

getName

public String getName()

Description copied from interface: IProcessTaskDefinition

This method returns the (unique) name of the task definition.

Specified by:

getName in interface IProcessTaskDefinition

Returns:

the (unique) name of the task definition.

getDescription

public String getDescription()

Description copied from interface: IProcessTaskDefinition

This method returns a description of the process task definition.

Specified by:

getDescription in interface IProcessTaskDefinition

Returns:

a description of the process task definition.

getDisplayName

public IMultilingualText getDisplayName()

Description copied from interface: IProcessTaskDefinition

This method returns a text object containing the name that should be used for display purposes. May be null.

Specified by:

getDisplayName in interface IProcessTaskDefinition

Returns:

a text object containing the name that should be used for display purposes.

getRoles

public IRole[] getRoles()

Description copied from interface: IProcessTaskDefinition

This method returns an array containing the roles that allow a user to execute the task. If the method returns an empty array, than the task may be execute by anyone, regardless of role. A user wishing to execute the task should have at least one of the required roles.

Specified by:

getRoles in interface IProcessTaskDefinition

Returns:

array containing the roles that allow a user to execute the task.

getRoutingAlgorithm

public IRoutingAlgorithmDefinition getRoutingAlgorithm()

Description copied from interface: IProcessTaskDefinition

This method returns the routing algorithm. If the method returns an empty array, than the task may be execute by anyone, regardless of routing algorithm.

Specified by:

getRoutingAlgorithm in interface IProcessTaskDefinition

Returns:

The routing algorithm

getAuthorizationAlgorithm

public IAuthorizationAlgorithmDefinition getAuthorizationAlgorithm()

Description copied from interface: IProcessTaskDefinition

This method returns the authorization algorithm. If none provided everyone may execute the task.

Specified by:

getAuthorizationAlgorithm in interface IProcessTaskDefinition

Returns:

The authorization algorithm, or null.

getPriorityAlgorithm

public IPriorityAlgorithmDefinition getPriorityAlgorithm()

Description copied from interface: IProcessTaskDefinition

This method returns the priority algorithm.

Specified by:

getPriorityAlgorithm in interface IProcessTaskDefinition

Returns:

The priority algorithm, or null.

getExitStates

public TaskExit[] getExitStates()

Description copied from interface: IProcessTaskDefinition

This method returns an array containing the possible exit states of the task. This array should always consist of at least two values, a continue exit and an abort exit. If more than one continue or cancel exit is present, then each exit must have a unique name.

Specified by:

getExitStates in interface IProcessTaskDefinition

Returns:

Array containing the possible exit states of the task.

getRetryCountExpression

public IExpression getRetryCountExpression()

Description copied from interface: IProcessTaskDefinition

This method returns the expression that should be evaluated for automatic tasks to determine the number of times the task should be retried in case of failure. When the method does not return a (valid) expression, the task will be executed once.

Specified by:

getRetryCountExpression in interface IProcessTaskDefinition

Returns:

Expression to determine the retry count for a failed automatic task.

getRetryInterval

public long getRetryInterval()

Description copied from interface: IProcessTaskDefinition

This method returns the interval in minutes the automatic task should wait before a failed task should be attempted again.

Specified by:

getRetryInterval in interface IProcessTaskDefinition

Returns:

The interval in minutes between execution attempts of the automatic task.

isAutomatic

public boolean isAutomatic()

Description copied from interface: IProcessTaskDefinition

This method returns a boolean indicating if the task is an automated task, and thus should be handled by the system in stead of a user.

Specified by:

isAutomatic in interface IProcessTaskDefinition

Returns:

a boolean indicating if the task is an automated task.

getDueDate

public IExpression getDueDate()

Description copied from interface: IProcessTaskDefinition

Gets the expression that determines the date on which this task should be ended.

Specified by:

getDueDate in interface IProcessTaskDefinition

Returns:

Expression resulting in a date.

getReevaluationEvent

public ReevaluationEvent getReevaluationEvent()

Description copied from interface: IProcessTaskDefinition

This method returns the reevaluation event

Specified by:

getReevaluationEvent in interface IProcessTaskDefinition

Returns:

The reevaluation event

getCustomFields

public IProcessTaskCustomField[] getCustomFields()

Description copied from interface: IProcessTaskDefinition

Gets the custom fields which are stored on this task.

Specified by:

getCustomFields in interface IProcessTaskDefinition

Returns:

Array of custom fields.