com.adobe.idp.taskmanager.dsc.client.query
Interface TaskRow

All Superinterfaces:

java.io.Serializable

public interface TaskRow
extends java.io.Serializable

A TaskRow object contains information pertaining to a single task. It is usually contained in a result set whose data is populated in response to a query.

Method Summary

long	getActionInstanceId() Retrieves the action identifier associated with the task.
long	getAssignmentQueueId() Retrieves the identifier for the assigned queue.
short	getAssignmentQueueType() Retrieves the assignment queue type.
short	getAssignmentStatus() Retrieves the assignment status.
short	getAssignmentType() Retrieves the assignment type.
java.lang.String	getClassOfTask() Returns the class of task.
java.util.Date	getCompleteTime() Determines when the task was completed.
java.lang.String	getConsultGroupId() Retrieves the consultation group identifier.
java.lang.String	getCreationId() The identifier of the user who created the task.
Assignment	getCurrentAssignment() Retrieves the current task assigment.
java.util.Date	getDeadline() Retrieves the deadline set for the task.
java.lang.String	getDescription() Retrieves the description for this task.
java.lang.String	getForwardGroupId() Retrieves the forward group identifier.
ImageTicket	getImageTicket() Retrieves the image ticket for the current task's process.
java.lang.String	getInstructions() Retrieves the task instructions, if any have been set.
java.lang.String	getLockedUserId() Retrieves the identifier of the user who currently has the task locked.
java.util.Date	getNextReminder() Retrieves the time when the next reminder for the task will be fired.
long	getNumForms() Retrieves the number of forms associated with this task.
long	getNumFormsToBeSaved() Determines the number of forms that have still not been saved.
java.lang.String	getOutOfOfficeCommonName() Retrieves the Common Name for the user who would have been assigned this task had they not been Out Of Office.
java.lang.String	getOutOfOfficeUserId() Retrieves the User Id for the user who would have been assigned this task had they not been Out Of Office.
java.lang.String	getParticipantIPAddress() Retrieves the IP Address optionally specified by a caller of completeTask() or save()
short	getPriority() Retrieves the task priority.
long	getProcessInstanceId() Retrieves the process instance identifier associated with the selected task.
short	getProcessInstanceStatus() Retrieves the process instance status.
int	getProcessMajorVersion() gets the major version of the process
int	getProcessMinorVersion() gets the minor version of the process
java.lang.String	getProcessName() Retrieves the process name for this task.
java.lang.String	getProcessTitle() Retrieves the process title for this task
java.util.List	getProcessVariables() Retrieves a list of process variables and their values.
java.lang.String	getQueueOwner() Retrieves the common name of the current user assigned to the task.
java.lang.String	getQueueOwnerId() Retrieves the identifier of the currently assigned user's queue.
long	getReminderCount() Retrieves the number of reminders set for this task.
java.lang.String[]	getRouteList() Retrieves the routes associated with this task.
long	getSavedFormCount() Retrieves the number of saved forms for this task.
java.lang.String	getSelectedRoute() Retrieves the selected route for this task.
java.util.Date	getStartTime() Determines when the task was started.
java.lang.String	getStepName() Retrieves the operation name for this task.
java.util.Date	getTaskCreateTime() The task creation time.
long	getTaskId() Retrieves the task identifier.
java.util.List	getTaskNotifications() Retrieves a list of task notifications if they have been added to the task definition.
short	getTaskStatus() Retrieves the current status of this task.
TaskRowUIOptions	getTaskUIOptions() Returns an object containing UI settings for this task.
java.util.Date	getTaskUpdateTime() Retrieves the time at which the task was last updated.
boolean	isRouteSelectionRequired() Determines whether a route must be selected to complete this task.
boolean	isShowAttachments() Determines whether the attachment window for this task is to be shown.
boolean	isStartTask() Determines whether the task is a start task.
boolean	isVisible() Determines whether this task is to be shown.
java.lang.String	toString() Retrieves a Stringrepresentation of this object.

Method Detail

getCreationId

java.lang.String getCreationId()

The identifier of the user who created the task.

Returns:

The identifier of the task creator.

getActionInstanceId

long getActionInstanceId()

Retrieves the action identifier associated with the task.

Returns:

The action identifier associated with this task.

getTaskStatus

short getTaskStatus()

Retrieves the current status of this task. See com.adobe.idp.taskmanager.dsc.client.task.TaskManagerConstants#TaskStatusTypes for the possible values.

Returns:

The current status of this task.

getTaskUpdateTime

java.util.Date getTaskUpdateTime()

Retrieves the time at which the task was last updated.

Returns:

A Date object containing the task update time.

getTaskCreateTime

java.util.Date getTaskCreateTime()

The task creation time.

Returns:

A Date object containing the task creation time.

getReminderCount

long getReminderCount()

Retrieves the number of reminders set for this task.

Returns:

The number of reminders.

getInstructions

java.lang.String getInstructions()

Retrieves the task instructions, if any have been set.

Returns:

A String containing the task instructions.

getTaskId

long getTaskId()

Retrieves the task identifier.

Returns:

The task identifier.

isShowAttachments

boolean isShowAttachments()

Determines whether the attachment window for this task is to be shown.

Returns:

true if the attachment window for this task is to be shown, false otherwise.

isVisible

boolean isVisible()

Determines whether this task is to be shown.

Returns:

true if this task is to be shown, false otherwise.

getDescription

java.lang.String getDescription()

Retrieves the description for this task.

Returns:

The description for this task.

getProcessName

java.lang.String getProcessName()

Retrieves the process name for this task.

Returns:

The process name for this task.

getProcessTitle

java.lang.String getProcessTitle()

Retrieves the process title for this task

Returns:

The process title for this task

getProcessMajorVersion

int getProcessMajorVersion()

gets the major version of the process

getProcessMinorVersion

int getProcessMinorVersion()

gets the minor version of the process

getStepName

java.lang.String getStepName()

Retrieves the operation name for this task.

Returns:

The step name for this task.

getSavedFormCount

long getSavedFormCount()

Retrieves the number of saved forms for this task.

Returns:

The number of saved forms for this task.

getCurrentAssignment

Assignment getCurrentAssignment()

Retrieves the current task assigment.

Returns:

An Assignment object containing the current assignment for the task.

getConsultGroupId

java.lang.String getConsultGroupId()

Retrieves the consultation group identifier.

Returns:

The consultation group identifier.

getDeadline

java.util.Date getDeadline()

Retrieves the deadline set for the task.

Returns:

A Date object representing the task deadline. null is returned if no deadline exists.

getForwardGroupId

java.lang.String getForwardGroupId()

Retrieves the forward group identifier.

Returns:

The forward group identifier. null is returned if no forward group identifier exists.

getNumFormsToBeSaved

long getNumFormsToBeSaved()

Determines the number of forms that have still not been saved.

Returns:

The number of forms that have still not been saved.

getNextReminder

java.util.Date getNextReminder()

Retrieves the time when the next reminder for the task will be fired.

Returns:

A Date object containing the time when the next reminder for the task will be fired. null is returned if no such reminder exists.

getNumForms

long getNumForms()

Retrieves the number of forms associated with this task.

Returns:

The number of forms associated with this task.

getProcessVariables

java.util.List getProcessVariables()

Retrieves a list of process variables and their values. This list will only be populated if the process variables are added to the result set.

Returns:

A List of MultiTypeVariable objects representing the process variables.

getPriority

short getPriority()

Retrieves the task priority.

Returns:

The task priority.

getRouteList

java.lang.String[] getRouteList()

Retrieves the routes associated with this task.

Returns:

An array of routes.

isRouteSelectionRequired

boolean isRouteSelectionRequired()

Determines whether a route must be selected to complete this task.

Returns:

true if a route must be selected, false otherwise.

getSelectedRoute

java.lang.String getSelectedRoute()

Retrieves the selected route for this task.

Returns:

The selected route for this task. null is returned if no route was selected.

isStartTask

boolean isStartTask()

Determines whether the task is a start task.

Returns:

true if the task is a start task, false otherwise.

getStartTime

java.util.Date getStartTime()

Determines when the task was started.

Returns:

A Date object containing the time the task was started.

getCompleteTime

java.util.Date getCompleteTime()

Determines when the task was completed.

Returns:

A Date object containing the time the task was completed.

getProcessInstanceId

long getProcessInstanceId()

Retrieves the process instance identifier associated with the selected task.

Returns:

The process instance identifier.

getProcessInstanceStatus

short getProcessInstanceStatus()

Retrieves the process instance status.

Returns:

The process instance status.

getAssignmentType

short getAssignmentType()

Retrieves the assignment type.

Returns:

The assignment type.

getAssignmentStatus

short getAssignmentStatus()

Retrieves the assignment status.

Returns:

The assignment status.

getAssignmentQueueId

long getAssignmentQueueId()

Retrieves the identifier for the assigned queue.

Returns:

The assigned queue identifier.

getAssignmentQueueType

short getAssignmentQueueType()

Retrieves the assignment queue type.

Returns:

The assignment queue type.

getQueueOwner

java.lang.String getQueueOwner()

Retrieves the common name of the current user assigned to the task.

Returns:

The commmon name of the assigned user.

getQueueOwnerId

java.lang.String getQueueOwnerId()

Retrieves the identifier of the currently assigned user's queue.

Returns:

The queue identifier.

getLockedUserId

java.lang.String getLockedUserId()

Retrieves the identifier of the user who currently has the task locked.

Returns:

The user identifier.

getImageTicket

ImageTicket getImageTicket()

Retrieves the image ticket for the current task's process.

Returns:

The image ticket.

getOutOfOfficeUserId

java.lang.String getOutOfOfficeUserId()

Retrieves the User Id for the user who would have been assigned this task had they not been Out Of Office.

Returns:

The User Identifier. Returns null if the task was not assigned on behalf of an out of office user

getOutOfOfficeCommonName

java.lang.String getOutOfOfficeCommonName()

Retrieves the Common Name for the user who would have been assigned this task had they not been Out Of Office.

Returns:

The User's Common name. Returns null if the task was not assigned on behalf of an out of office user

getTaskNotifications

java.util.List getTaskNotifications()

Retrieves a list of task notifications if they have been added to the task definition.

Returns:

A List of taskNotifications for the task if they exist.

getClassOfTask

java.lang.String getClassOfTask()

Returns the class of task. Tasks may be created with arbitrary classes.

The known classes are here: TaskManagerConstants.TaskClassTypes

Returns:

The class of task.

getTaskUIOptions

TaskRowUIOptions getTaskUIOptions()

Returns an object containing UI settings for this task.

Returns:

UI Settings for this task..

getParticipantIPAddress

java.lang.String getParticipantIPAddress()

Retrieves the IP Address optionally specified by a caller of completeTask() or save()

Returns:

toString

java.lang.String toString()

Retrieves a Stringrepresentation of this object.

Overrides:

toString in class java.lang.Object

Returns:

A Stringrepresentation of this object.