Package com.aquima.interactions.process.impl

Class ProcessTaskView

java.lang.Object

com.aquima.interactions.process.impl.ProcessTaskView

All Implemented Interfaces:

IProcessTaskView

public class ProcessTaskView
extends Object
implements IProcessTaskView

Constructor Summary

Constructors

Constructor	Description
ProcessTaskView(IProcessTaskDefinition definition, ITaskQueryResult task)

Method Summary

Modifier and Type	Method	Description
IAssigneeInfo	getAssigneeInfo()	This method returns the AssigneeInfo of whom the task is assigned to.
AttributeReference[]	getAttributes()	this method returns the attributes from the case for which a value is set
IValue	getAttributeValue(String entityName, String attributeName)	this method returns the value of the attribute from the case the task is defined for.
long	getCaseId()	This method returns the ID of the case the task is defined for.
String[]	getCustomFields()	this method returns the custom fields defined for the task
IValue	getCustomFieldValue(String customField)	this method returns the value of a custom field for the task.
String	getDescription()	This method returns the description of the task as present in the task definition.
IMultilingualText	getDisplayName()	This method returns the display name of the task as present in the task definition.
DateTimeValue	getDueDate()	this method returns the date at which the task should be completed.
long	getId()	This method returns the unique ID of this task.
String	getName()	This method returns the name of the task as present in the task definition.
GUID	getNodeId()	This method returns the optional node ID this task belongs to.
Integer	getPriority()	This method returns the priority of this task.
IRole[]	getRequiredRoles()	This method returns the names of required roles to start this task.
IRoutingAlgorithmDefinition	getRequiredRoutingAlgorithm()	This method returns the names of required routing algorithms to start this task.
DateTimeValue	getStartDate()	This method returns the date at which the task may start.
TaskStatusType	getStatus()	This method returns the current status of the task.
DateTimeValue	getTimeoutDate()	this method returns the date at which the task will expire
boolean	isCaseLocked()	This method returns if the case the task is defined for is locked.
boolean	isRequired()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessTaskView

public ProcessTaskView(IProcessTaskDefinition definition,
                       ITaskQueryResult task)

Method Detail

getId

public long getId()

Description copied from interface: IProcessTaskView

This method returns the unique ID of this task.

Specified by:

getId in interface IProcessTaskView

Returns:

the unique ID of this process step.

getNodeId

public GUID getNodeId()

Description copied from interface: IProcessTaskView

This method returns the optional node ID this task belongs to.

Specified by:

getNodeId in interface IProcessTaskView

Returns:

the node ID of this task.

getPriority

public Integer getPriority()

Description copied from interface: IProcessTaskView

This method returns the priority of this task.

Specified by:

getPriority in interface IProcessTaskView

Returns:

the priority of this task.

getCaseId

public long getCaseId()

Description copied from interface: IProcessTaskView

This method returns the ID of the case the task is defined for.

Specified by:

getCaseId in interface IProcessTaskView

Returns:

The ID of the case the task is defined for.

isCaseLocked

public boolean isCaseLocked()

Description copied from interface: IProcessTaskView

This method returns if the case the task is defined for is locked.

Specified by:

isCaseLocked in interface IProcessTaskView

Returns:

a boolean indicating if the case the task is defined for is locked

getAssigneeInfo

public IAssigneeInfo getAssigneeInfo()

Description copied from interface: IProcessTaskView

This method returns the AssigneeInfo of whom the task is assigned to.

Specified by:

getAssigneeInfo in interface IProcessTaskView

Returns:

the AssigneeInfo of whom the task is assigned to.

getName

public String getName()

Description copied from interface: IProcessTaskView

This method returns the name of the task as present in the task definition.

Specified by:

getName in interface IProcessTaskView

Returns:

The name of the task.

getDescription

public String getDescription()

Description copied from interface: IProcessTaskView

This method returns the description of the task as present in the task definition.

Specified by:

getDescription in interface IProcessTaskView

Returns:

The description of the task.

getDisplayName

public IMultilingualText getDisplayName()

Description copied from interface: IProcessTaskView

This method returns the display name of the task as present in the task definition.

Specified by:

getDisplayName in interface IProcessTaskView

Returns:

The display name of the task.

getRequiredRoles

public IRole[] getRequiredRoles()

Description copied from interface: IProcessTaskView

This method returns the names of required roles to start this task.

Specified by:

getRequiredRoles in interface IProcessTaskView

Returns:

The names of the required roles.

getRequiredRoutingAlgorithm

public IRoutingAlgorithmDefinition getRequiredRoutingAlgorithm()

Description copied from interface: IProcessTaskView

This method returns the names of required routing algorithms to start this task.

Specified by:

getRequiredRoutingAlgorithm in interface IProcessTaskView

Returns:

The names of the required routing algorithms.

getStatus

public TaskStatusType getStatus()

Description copied from interface: IProcessTaskView

This method returns the current status of the task.

Specified by:

getStatus in interface IProcessTaskView

Returns:

the current status of the task.

getStartDate

public DateTimeValue getStartDate()

Description copied from interface: IProcessTaskView

This method returns the date at which the task may start.

Specified by:

getStartDate in interface IProcessTaskView

Returns:

The date at which the task may start.

getTimeoutDate

public DateTimeValue getTimeoutDate()

Description copied from interface: IProcessTaskView

this method returns the date at which the task will expire

Specified by:

getTimeoutDate in interface IProcessTaskView

Returns:

The date at which the task will expire

getDueDate

public DateTimeValue getDueDate()

Description copied from interface: IProcessTaskView

this method returns the date at which the task should be completed.

Specified by:

getDueDate in interface IProcessTaskView

Returns:

The date at which the task should be completed.

getAttributeValue

public IValue getAttributeValue(String entityName,
                                String attributeName)

Description copied from interface: IProcessTaskView

this method returns the value of the attribute from the case the task is defined for.

Specified by:

getAttributeValue in interface IProcessTaskView

Parameters:

entityName - The entity where the attribute belongs to.

attributeName - The name of the attribute.

Returns:

The value of the attribute from the case the task is defined for.

getAttributes

public AttributeReference[] getAttributes()

Description copied from interface: IProcessTaskView

this method returns the attributes from the case for which a value is set

Specified by:

getAttributes in interface IProcessTaskView

Returns:

getCustomFieldValue

public IValue getCustomFieldValue(String customField)

Description copied from interface: IProcessTaskView

this method returns the value of a custom field for the task.

Specified by:

getCustomFieldValue in interface IProcessTaskView

Parameters:

customField - The custom field.

Returns:

The value of the custom field from the task.

getCustomFields

public String[] getCustomFields()

Description copied from interface: IProcessTaskView

this method returns the custom fields defined for the task

Specified by:

getCustomFields in interface IProcessTaskView

Returns:

isRequired

public boolean isRequired()

Specified by:

isRequired in interface IProcessTaskView