atg.workflow

Class TaskInfo

java.lang.Object

atg.workflow.TaskInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class TaskInfo
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable

Description of the runtime state of an identified task relative to some workflow instance. Keeps track of such information as the task's priority, its owner, the user who last acted on the task, the last outcome taken, and so on.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
TaskInfo(TaskDescriptor pTaskDescriptor) Constructs a new TaskInfo with the given TaskDescriptor.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o) Compares two TaskInfos using the default sorting criteria.
AccessControlList	getAccessControlList() Returns this task's access control list.
java.sql.Timestamp	getLastActionDate() Returns the Timestamp date of the last action upon this task.
DirectoryPrincipal	getLastActor() Returns the DirectoryPrincipal for the last user to act on this task, or null if the task has not been acted on.
java.lang.String	getLastActorName() Returns the unique atg.security.Persona name of the last user to act upon this task, or null if the task has not been acted on.
java.lang.String	getLastOutcomeElementId() Returns the process element id of the last outcome for this task.
DirectoryPrincipal	getOwner() Returns the DirectoryPrincipal for the owner of this task, or null if it is unowned.
java.lang.String	getOwnerName() Returns the unique atg.security.Persona name of the owner of this task, or null if it is unowned.
int	getPriority() Returns this task's priority.
AccessControlList	getRuntimeAccessControlList() Returns this task's runtime access control list.
java.lang.String	getRuntimeAclString() Returns the String representation of this task's runtime access control list.
java.lang.String	getSubjectId() Returns the repository id of the workflow subject associated with this task.
TaskDescriptor	getTaskDescriptor() Returns the TaskDescriptor for this task.
boolean	isActionTaken() Returns true if this task has been acted upon, false otherwise.
boolean	isActive() Returns true if this task is currently active, false otherwise.
void	setActive(boolean pActive) Sets the flag indicating whether this task is currently active.
void	setLastActionDate(java.sql.Timestamp pLastActionDate) Sets the Timestamp date of the last action upon this task.
void	setLastActorName(java.lang.String pLastActorName) Sets the unique atg.security.Persona name of the last user to act upon this task.
void	setLastOutcomeElementId(java.lang.String pLastOutcomeElementId) Sets the process element id of the last outcome for this task.
void	setOwnerName(java.lang.String pOwnerName) Sets the unique atg.security.Persona name of the owner of this task.
void	setPriority(int pPriority) Sets this task's priority.
void	setRuntimeAclString(java.lang.String pRuntimeAclString) Sets the String representation of this task's runtime access control list.
void	setSubjectId(java.lang.String pSubjectId) Sets the repository id of the workflow subject associated with this task.
void	setTaskDescriptor(TaskDescriptor pTaskDescriptor) Sets the TaskDescriptor for this task.
java.lang.String	toString() Returns a String representation of this TaskInfo.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

TaskInfo

public TaskInfo(TaskDescriptor pTaskDescriptor)

Constructs a new TaskInfo with the given TaskDescriptor. The rest of the properties remain unset and must be subsequently filled in.

Parameters:

pTaskDescriptor - the TaskDescriptor which describes this task

Method Detail

getTaskDescriptor

public TaskDescriptor getTaskDescriptor()

Returns the TaskDescriptor for this task.

setTaskDescriptor

public void setTaskDescriptor(TaskDescriptor pTaskDescriptor)

Sets the TaskDescriptor for this task.

getSubjectId

public java.lang.String getSubjectId()

Returns the repository id of the workflow subject associated with this task.

setSubjectId

public void setSubjectId(java.lang.String pSubjectId)

Sets the repository id of the workflow subject associated with this task.

isActive

public boolean isActive()

Returns true if this task is currently active, false otherwise.

setActive

public void setActive(boolean pActive)

Sets the flag indicating whether this task is currently active.

getRuntimeAclString

public java.lang.String getRuntimeAclString()

Returns the String representation of this task's runtime access control list. Returns null if the task's ACL has not been explicitly set at runtime to override the TaskDescriptor's ACL.

See Also:

AccessControlList

setRuntimeAclString

public void setRuntimeAclString(java.lang.String pRuntimeAclString)

Sets the String representation of this task's runtime access control list.

See Also:

AccessControlList

getRuntimeAccessControlList

public AccessControlList getRuntimeAccessControlList()

Returns this task's runtime access control list. Returns null if the task's ACL has not been explicitly set at runtime to override the TaskDescriptor's ACL.

getAccessControlList

public AccessControlList getAccessControlList()

Returns this task's access control list. Specifically, this returns the runtime ACL if it has been explicitly set, otherwise it returns the TaskDescriptor's ACL.

getPriority

public int getPriority()

Returns this task's priority.

setPriority

public void setPriority(int pPriority)

Sets this task's priority.

getOwnerName

public java.lang.String getOwnerName()

Returns the unique atg.security.Persona name of the owner of this task, or null if it is unowned.

See Also:

Persona

setOwnerName

public void setOwnerName(java.lang.String pOwnerName)

Sets the unique atg.security.Persona name of the owner of this task.

Parameters:

pOwnerName - the unique name of the owning user, or null to indicate no owner

See Also:

Persona

getOwner

public DirectoryPrincipal getOwner()

Returns the DirectoryPrincipal for the owner of this task, or null if it is unowned.

getLastActorName

public java.lang.String getLastActorName()

Returns the unique atg.security.Persona name of the last user to act upon this task, or null if the task has not been acted on.

See Also:

Persona

setLastActorName

public void setLastActorName(java.lang.String pLastActorName)

Sets the unique atg.security.Persona name of the last user to act upon this task.

Parameters:

pLastActorName - the unique name of the last actor

See Also:

Persona

getLastActor

public DirectoryPrincipal getLastActor()

Returns the DirectoryPrincipal for the last user to act on this task, or null if the task has not been acted on.

getLastActionDate

public java.sql.Timestamp getLastActionDate()

Returns the Timestamp date of the last action upon this task.

setLastActionDate

public void setLastActionDate(java.sql.Timestamp pLastActionDate)

Sets the Timestamp date of the last action upon this task.

isActionTaken

public boolean isActionTaken()

Returns true if this task has been acted upon, false otherwise.

getLastOutcomeElementId

public java.lang.String getLastOutcomeElementId()

Returns the process element id of the last outcome for this task.

Returns:

the process element id of the outcome element, as it appears in the workflow definition file

setLastOutcomeElementId

public void setLastOutcomeElementId(java.lang.String pLastOutcomeElementId)

Sets the process element id of the last outcome for this task.

Parameters:

pLastOutcomeElementId - the process element id of the outcome element, as it appears in the workflow definition file

compareTo

public int compareTo(java.lang.Object o)

Compares two TaskInfos using the default sorting criteria. Specifically, TaskInfos are sorted first by the workflow process/segment names and subject ids (i.e., all the tasks which belong to a single workflow instance are grouped together), then by their order of appearance in the workflow definition.

Returns a negative integer, zero, or a positive integer depending on whether this TaskInfo is less than, equal to, or greater than the specified TaskInfo.

Specified by:

compareTo in interface java.lang.Comparable

toString

public java.lang.String toString()

Returns a String representation of this TaskInfo.

Overrides:

toString in class java.lang.Object