Package com.aquima.interactions.process.ds.xml.r8.parsing

Class XmlProcessTaskDS

java.lang.Object

com.aquima.interactions.foundation.report.ReportingDS

com.aquima.interactions.process.ds.xml.r8.parsing.XmlProcessTaskDS

All Implemented Interfaces:

IReportingDS, IProcessTaskDS

public class XmlProcessTaskDS
extends ReportingDS
implements IProcessTaskDS

Xml r8 datasource implementation.

Since:

7.2

Author:

Jon van Leuven

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XmlProcessTaskDS(IInitializationReport report, IXmlNode node)

Method Summary

Modifier and Type	Method	Description
String	getAuthorizationAlgorithmName()	This method returns the name of the authorization algorithm to use.
IProcessTaskCustomFieldDS[]	getCustomFields()	Gets the custom fields set on this process 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.
String	getDueDate()	Gets the expression that determines the date on which this task should be ended.
TaskExit[]	getExitStates()	This method returns the possible exit states of the task.
GUID	getId()	This method should return the unique id of the process task.
String	getName()	This method returns the (unique) name of the task definition.
String	getPriorityAlgorithmName()	This method returns the name of the priority algorithm
ReevaluationEvent	getReevaluationEvent()	This method returns the reevaluation event
String	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.
String[]	getRoles()	This method returns an array containing the roles that allow a user to execute the task.
String	getRoutingAlgorithmName()	This method returns the name of 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 com.aquima.interactions.foundation.report.ReportingDS

addError, addMessage, getCategory, getReport

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aquima.interactions.foundation.report.IReportingDS

addMessage

Constructor Detail

XmlProcessTaskDS

protected XmlProcessTaskDS(IInitializationReport report,
                           IXmlNode node)

Method Detail

getDescription

public String getDescription()

Description copied from interface: IProcessTaskDS

This method returns a description of the process task definition.

Specified by:

getDescription in interface IProcessTaskDS

Returns:

a description of the process task definition.

getDisplayName

public IMultilingualText getDisplayName()

Description copied from interface: IProcessTaskDS

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

Specified by:

getDisplayName in interface IProcessTaskDS

Returns:

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

getExitStates

public TaskExit[] getExitStates()

Description copied from interface: IProcessTaskDS

This method returns the possible exit states of the task. The abort task exit will always be available for a task, so this method only needs to return exit of the type cancel and continue.

Specified by:

getExitStates in interface IProcessTaskDS

Returns:

Array containing the possible exit states.

getName

public String getName()

Description copied from interface: IProcessTaskDS

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

Specified by:

getName in interface IProcessTaskDS

Returns:

the (unique) name of the task definition.

getRoles

public String[] getRoles()

Description copied from interface: IProcessTaskDS

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 IProcessTaskDS

Returns:

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

getAuthorizationAlgorithmName

public String getAuthorizationAlgorithmName()

Description copied from interface: IProcessTaskDS

This method returns the name of the authorization algorithm to use. If no algorithm is specified the task may be executed by everyone.

Specified by:

getAuthorizationAlgorithmName in interface IProcessTaskDS

Returns:

The name of the authorization algorithm, or null.

getPriorityAlgorithmName

public String getPriorityAlgorithmName()

Description copied from interface: IProcessTaskDS

This method returns the name of the priority algorithm

Specified by:

getPriorityAlgorithmName in interface IProcessTaskDS

Returns:

The name of the priority algorithm, or null

getRoutingAlgorithmName

public String getRoutingAlgorithmName()

Description copied from interface: IProcessTaskDS

This method returns the name of the routing algorithm

Specified by:

getRoutingAlgorithmName in interface IProcessTaskDS

Returns:

The name of the routing algorithm, or null

getRetryCountExpression

public String getRetryCountExpression()

Description copied from interface: IProcessTaskDS

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 IProcessTaskDS

Returns:

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

getRetryInterval

public long getRetryInterval()

Description copied from interface: IProcessTaskDS

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 IProcessTaskDS

Returns:

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

isAutomatic

public boolean isAutomatic()

Description copied from interface: IProcessTaskDS

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 IProcessTaskDS

Returns:

a boolean indicating if the task is an automated task.

getId

public GUID getId()

Description copied from interface: IProcessTaskDS

This method should return the unique id of the process task.

Specified by:

getId in interface IProcessTaskDS

Returns:

String containing the id of the process task.

getDueDate

public String getDueDate()

Description copied from interface: IProcessTaskDS

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

Specified by:

getDueDate in interface IProcessTaskDS

Returns:

Expression resulting in a date.

getReevaluationEvent

public ReevaluationEvent getReevaluationEvent()

Description copied from interface: IProcessTaskDS

This method returns the reevaluation event

Specified by:

getReevaluationEvent in interface IProcessTaskDS

Returns:

The reevaluation event

getCustomFields

public IProcessTaskCustomFieldDS[] getCustomFields()

Description copied from interface: IProcessTaskDS

Gets the custom fields set on this process task.

Specified by:

getCustomFields in interface IProcessTaskDS

Returns:

Array of custom fields.