|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TaskRow
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 String representation of this object. |
Method Detail |
---|
java.lang.String getCreationId()
long getActionInstanceId()
short getTaskStatus()
com.adobe.idp.taskmanager.dsc.client.task.TaskManagerConstants#TaskStatusTypes
for the possible values.
java.util.Date getTaskUpdateTime()
Date
object containing the task update time.java.util.Date getTaskCreateTime()
Date
object containing the task creation time.long getReminderCount()
java.lang.String getInstructions()
String
containing the task instructions.long getTaskId()
boolean isShowAttachments()
true
if the attachment window for this task is to be shown, false
otherwise.boolean isVisible()
true
if this task is to be shown, false
otherwise.java.lang.String getDescription()
java.lang.String getProcessName()
java.lang.String getProcessTitle()
int getProcessMajorVersion()
int getProcessMinorVersion()
java.lang.String getStepName()
long getSavedFormCount()
Assignment getCurrentAssignment()
Assignment
object containing the current assignment for the task.java.lang.String getConsultGroupId()
java.util.Date getDeadline()
Date
object representing the task deadline. null
is returned if no deadline exists.java.lang.String getForwardGroupId()
null
is returned if no forward group identifier exists.long getNumFormsToBeSaved()
java.util.Date getNextReminder()
Date
object containing the time when the next reminder for the task will be fired.
null
is returned if no such reminder exists.long getNumForms()
java.util.List getProcessVariables()
List
of MultiTypeVariable
objects representing the process variables.short getPriority()
java.lang.String[] getRouteList()
boolean isRouteSelectionRequired()
true
if a route must be selected, false
otherwise.java.lang.String getSelectedRoute()
null
is returned if no route was selected.boolean isStartTask()
true
if the task is a start task, false
otherwise.java.util.Date getStartTime()
Date
object containing the time the task was started.java.util.Date getCompleteTime()
Date
object containing the time the task was completed.long getProcessInstanceId()
short getProcessInstanceStatus()
short getAssignmentType()
short getAssignmentStatus()
long getAssignmentQueueId()
short getAssignmentQueueType()
java.lang.String getQueueOwner()
java.lang.String getQueueOwnerId()
java.lang.String getLockedUserId()
ImageTicket getImageTicket()
java.lang.String getOutOfOfficeUserId()
null
if the task was not assigned on behalf of an out of office userjava.lang.String getOutOfOfficeCommonName()
null
if the task was not assigned on behalf of an out of office userjava.util.List getTaskNotifications()
List
of taskNotifications for the task if they exist.java.lang.String getClassOfTask()
Returns the class of task. Tasks may be created with arbitrary classes.
The known classes are here: TaskManagerConstants.TaskClassTypes
TaskRowUIOptions getTaskUIOptions()
Returns an object containing UI settings for this task.
java.lang.String getParticipantIPAddress()
java.lang.String toString()
String
representation of this object.
toString
in class java.lang.Object
String
representation of this object.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |