Class ProcessTaskDefinition
java.lang.Object
com.aquima.interactions.process.impl.ProcessTaskDefinition
- All Implemented Interfaces:
IProcessTaskDefinition
This class contains a single process task definition.
- Since:
- 7.1
- Author:
- O. Kerpershoek
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
ProcessTaskDefinition
(IProcessTaskDS datasource, IProject project, IExpressionParser parser, IProcessEngineDefinitions processEngineDefinitions) -
Method Summary
Modifier and TypeMethodDescriptionThis method returns the authorization algorithm.Gets the custom fields which are stored on this task.This method returns a description of the process task definition.This method returns a text object containing the name that should be used for display purposes.Gets the expression that determines the date on which this task should be ended.TaskExit[]
This method returns an array containing the possible exit states of the task.getId()
This method returns the unique identifier of the task definition.getName()
This method returns the (unique) name of the task definition.This method returns the priority algorithm.This method returns the reevaluation eventThis 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
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.This method returns the routing algorithm.boolean
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.
-
Constructor Details
-
ProcessTaskDefinition
protected ProcessTaskDefinition(IProcessTaskDS datasource, IProject project, IExpressionParser parser, IProcessEngineDefinitions processEngineDefinitions)
-
-
Method Details
-
getId
Description copied from interface:IProcessTaskDefinition
This method returns the unique identifier of the task definition.- Specified by:
getId
in interfaceIProcessTaskDefinition
- Returns:
- the unique identifier of the task definition.
-
getName
Description copied from interface:IProcessTaskDefinition
This method returns the (unique) name of the task definition.- Specified by:
getName
in interfaceIProcessTaskDefinition
- Returns:
- the (unique) name of the task definition.
-
getDescription
Description copied from interface:IProcessTaskDefinition
This method returns a description of the process task definition.- Specified by:
getDescription
in interfaceIProcessTaskDefinition
- Returns:
- a description of the process task definition.
-
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 interfaceIProcessTaskDefinition
- Returns:
- a text object containing the name that should be used for display purposes.
-
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 interfaceIProcessTaskDefinition
- Returns:
- array containing the roles that allow a user to execute the task.
-
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 interfaceIProcessTaskDefinition
- Returns:
- The routing algorithm
-
getAuthorizationAlgorithm
Description copied from interface:IProcessTaskDefinition
This method returns the authorization algorithm. If none provided everyone may execute the task.- Specified by:
getAuthorizationAlgorithm
in interfaceIProcessTaskDefinition
- Returns:
- The authorization algorithm, or null.
-
getPriorityAlgorithm
Description copied from interface:IProcessTaskDefinition
This method returns the priority algorithm.- Specified by:
getPriorityAlgorithm
in interfaceIProcessTaskDefinition
- Returns:
- The priority algorithm, or null.
-
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 interfaceIProcessTaskDefinition
- Returns:
- Array containing the possible exit states of the task.
-
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 interfaceIProcessTaskDefinition
- 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 interfaceIProcessTaskDefinition
- 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 interfaceIProcessTaskDefinition
- Returns:
- a boolean indicating if the task is an automated task.
-
getDueDate
Description copied from interface:IProcessTaskDefinition
Gets the expression that determines the date on which this task should be ended.- Specified by:
getDueDate
in interfaceIProcessTaskDefinition
- Returns:
- Expression resulting in a date.
-
getReevaluationEvent
Description copied from interface:IProcessTaskDefinition
This method returns the reevaluation event- Specified by:
getReevaluationEvent
in interfaceIProcessTaskDefinition
- Returns:
- The reevaluation event
-
getCustomFields
Description copied from interface:IProcessTaskDefinition
Gets the custom fields which are stored on this task.- Specified by:
getCustomFields
in interfaceIProcessTaskDefinition
- Returns:
- Array of custom fields.
-