com.adobe.idp.taskmanager.dsc.client.task
Interface TaskInfo

All Superinterfaces:

CreateTaskInfo, java.io.Serializable

public interface TaskInfo
extends CreateTaskInfo, java.io.Serializable

A TaskInfo object contains all relevant information about a task that is stored in the system.

See Also:

TaskManager.getTaskInfo()

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.idp.taskmanager.dsc.client.task.CreateTaskInfo

CreateTaskInfo.PriorityValues

Method Summary

long	getActionId() Retrieves the action identifier that corresponds to this task.
long	getActionInstanceId() Retrieves the action instance identifer associated with this task, if it exists.
ParticipantInfo	getAssignedTo() Retrieves the information for whom the task is assigned.
java.util.Date	getAssignmentCreateTime() Retrieves the date when the task was assigned.
short	getAssignmentStatus() Retrieves the assignment status.
short	getAssignmentSubStatus() Retrieves the assignment sub-status.
short	getAssignmentType() Retrieves the assignment type for this task.
java.util.Date	getAssignmentUpdateTime() Retrieves the date when the task was updated.
AttachmentInfo[]	getAttachments() Retrieves information about the attachments for this task.
java.lang.String	getClassOfTask() returns the class of task.
java.lang.String	getCompletionNote() returns a completion note for this task, if one was saved
java.lang.String	getConsultGroupId() Retrieves the group identifer with which tasks can be consulted.
java.util.Date	getCreateTime() Retrieves the date when a task was created.
long	getCurrentAssignmentId() Retrieves the current assignemnt identifier.
java.util.Date	getDeadline() Retrieves the deadline for this task.
TaskTimerInfo	getDeadlineInfo() Deprecated. - not implemented
TaskACL	getDefaultACLs() Retrieves the default ACL for this task.
java.lang.String	getDescription() Retrieves the description for this task.
java.lang.String	getDisplayName() Retrieves the display name for this task.
TaskTimerInfo	getEscalationInfo() Deprecated. - not implemented
TaskTimerInfo	getFirstReminderInfo() Deprecated. - not implemented
java.lang.String	getForwardGroupId() Retrieves the group identifer to which tasks can be forwarded.
ImageTicket	getImageTicket() Retrieves an image ticket for this task.
java.lang.String	getInstructions() Retrieves the instructions for this task.
java.util.Date	getNextReminder() Retrieves the reminder date for this task.
long	getNumForms() Retrieves the number of task items (forms) for this task.
long	getNumFormsToBeSaved() Retrieves the number of task items (forms) for this task that must be saved before the task can be completed.
ParticipantInfo	getOOODesignatedFor() Retrieves the information for whom the task would have been assigned 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 priority for this task.
long	getProcessInstanceId() Retrieves the process instance identifer associated with this task, if it exists.
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 a task if it is part of a process.
java.lang.String	getProcessTitle() Retrieves the process title
long	getReminderCount() Retrieves the number of times a user was reminded to complete this task.
TaskTimerInfo	getRepeatReminderInfo() Retrieves the RepeatReminderInfo for this task.
java.lang.String[]	getRouteList() Retrieves the route list for this task.
boolean	getRouteSelectionRequired() Determines whether a route must be selected for the task to be completed.
java.lang.String	getSelectedRoute() Retrieves the selected route.
java.util.Date	getSLATargetDate() returns the SLA target date for this task
java.lang.String	getStepName() Retrieves the step name for this task.
java.lang.String	getSummaryUrl() Retrieves the summary URL for this task.
TaskACL[]	getTaskACLs() Retrieves the ACLs set on this task.
long	getTaskID() Retrieves the task identifier.
FormInstance[]	getTaskItems() Retrieves the list of task items.
short	getTaskStatus() Retrieves the status for this task.
TaskUIOptions	getTaskUIOptions() Retrieves the specific taskUI options for this task.
java.util.Date	getUpdateTime() Retrieves the date when a task was updated.
boolean	isLocked() Determines whether the task is locked.
boolean	isOutOfOfficeEligible() Retrieves whehter or not this task is eligable for Out Of Office designation
boolean	isStartTask() Determines whether this task is a start task.
boolean	isVisible() Determines whether the task is visible.
boolean	showAttachments() Determines whether the attachment window for this task should be shown.

Methods inherited from interface com.adobe.idp.taskmanager.dsc.client.task.CreateTaskInfo

addACLsForSharedQueues, copyAttachments, isStartTask, setActionId, setAssignTo, setAttachmentDocumentList, setClassOfTask, setConsultGroup, setConsultGroupId, setDeadline, setDeadlineInfo, setDeadlineInstructions, setDeadlineRouteName, setDefaultACLs, setDescription, setDisplayName, setEscalateTo, setEscalation, setEscalationInfo, setFirstReminder, setFirstReminderInfo, setForwardGroup, setForwardGroupId, setInstructions, setLongLivedInvocationId, setOutOfOfficeEligible, setOutOfOfficeEligibleEscalations, setPriority, setProcessInstanceId, setProcessMajorVersion, setProcessMinorVersion, setProcessName, setProcessTitle, setReminderInstructions, setReminderRepeatMinutes, setRepeatReminderInfo, setRouteList, setRouteSelectionRequired, setSelectedRoute, setSLATargetDateInfo, setStepName, setSummaryUrl, setTaskACLs, setTaskItems, setTaskUIOptions, showAttachments

Method Detail

getTaskItems

FormInstance[] getTaskItems()

Retrieves the list of task items.

Returns:

The list of task items.

getTaskID

long getTaskID()

Retrieves the task identifier.

Returns:

The task identifier.

getDeadline

java.util.Date getDeadline()

Retrieves the deadline for this task.

Returns:

The deadline for this task.

getNextReminder

java.util.Date getNextReminder()

Retrieves the reminder date for this task.

Returns:

The reminder date for this task.

getClassOfTask

java.lang.String getClassOfTask()

returns the class of task.

showAttachments

boolean showAttachments()

Determines whether the attachment window for this task should be shown.

Returns:

true if the attachment window should be shown, false otherwise.

getAttachments

AttachmentInfo[] getAttachments()

Retrieves information about the attachments for this task.

Returns:

An array of AttachmentInfo objects that provide details (but not the content) about this task's attachments.

getAssignedTo

ParticipantInfo getAssignedTo()

Retrieves the information for whom the task is assigned.

getOOODesignatedFor

ParticipantInfo getOOODesignatedFor()

Retrieves the information for whom the task would have been assigned had they not been out of office.

getActionId

long getActionId()

Retrieves the action identifier that corresponds to this task.

Returns:

The action identifier that corresponds to this task.

getProcessName

java.lang.String getProcessName()

Retrieves the process name for a task if it is part of a process.

Returns:

The process name.

getProcessTitle

java.lang.String getProcessTitle()

Retrieves the process title

Returns:

getProcessMajorVersion

int getProcessMajorVersion()

gets the major version of the process

getProcessMinorVersion

int getProcessMinorVersion()

gets the minor version of the process

getInstructions

java.lang.String getInstructions()

Retrieves the instructions for this task.

Returns:

This task's instructions.

getSummaryUrl

java.lang.String getSummaryUrl()

Retrieves the summary URL for this task.

Returns:

This task's summary URL.

getDescription

java.lang.String getDescription()

Retrieves the description for this task.

Returns:

This task's description.

getStepName

java.lang.String getStepName()

Retrieves the step name for this task.

Returns:

This task's step name.

getDisplayName

java.lang.String getDisplayName()

Retrieves the display name for this task.

Returns:

This task's display name.

getTaskACLs

TaskACL[] getTaskACLs()

Retrieves the ACLs set on this task.

Returns:

This task's ACLs.

isStartTask

boolean isStartTask()

Determines whether this task is a start task.

Returns:

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

isVisible

boolean isVisible()

Determines whether the task is visible. Completed tasks can be set to be not visible.

Returns:

true if the task is not visible, false otherwise.

getDefaultACLs

TaskACL getDefaultACLs()

Retrieves the default ACL for this task.

Returns:

The default ACL for this task.

getTaskStatus

short getTaskStatus()

Retrieves the status for this task.

Returns:

The status for this task.

getAssignmentType

short getAssignmentType()

Retrieves the assignment type for this task.

Returns:

The assignment type for this task.

getAssignmentStatus

short getAssignmentStatus()

Retrieves the assignment status.

Returns:

The assignment status.

getAssignmentSubStatus

short getAssignmentSubStatus()

Retrieves the assignment sub-status.

Returns:

The assignment sub-status.

isLocked

boolean isLocked()

Determines whether the task is locked.

Returns:

true if the task is locked, false otherwise.

getNumForms

long getNumForms()

Retrieves the number of task items (forms) for this task.

Returns:

The number of task items.

getNumFormsToBeSaved

long getNumFormsToBeSaved()

Retrieves the number of task items (forms) for this task that must be saved before the task can be completed.

Returns:

The number of task items that must be saved.

getRouteList

java.lang.String[] getRouteList()

Retrieves the route list for this task.

Returns:

The route list.

getSelectedRoute

java.lang.String getSelectedRoute()

Retrieves the selected route.

Returns:

The selected route.

getRouteSelectionRequired

boolean getRouteSelectionRequired()

Determines whether a route must be selected for the task to be completed.

Returns:

true if the route selection must be performed, false otherwise.

getForwardGroupId

java.lang.String getForwardGroupId()

Retrieves the group identifer to which tasks can be forwarded.

Returns:

The group identifer to which tasks can be forwarded.

getConsultGroupId

java.lang.String getConsultGroupId()

Retrieves the group identifer with which tasks can be consulted.

Returns:

The group identifer with which tasks can be consulted.

getProcessInstanceId

long getProcessInstanceId()

Retrieves the process instance identifer associated with this task, if it exists.

Returns:

The process instance identifer associated with this task.

getActionInstanceId

long getActionInstanceId()

Retrieves the action instance identifer associated with this task, if it exists.

Returns:

The action instance identifer associated with this task.

getCreateTime

java.util.Date getCreateTime()

Retrieves the date when a task was created.

Returns:

The date when a task was created.

getUpdateTime

java.util.Date getUpdateTime()

Retrieves the date when a task was updated.

Returns:

The date when a task was updated.

getReminderCount

long getReminderCount()

Retrieves the number of times a user was reminded to complete this task.

Returns:

The reminder count.

getCurrentAssignmentId

long getCurrentAssignmentId()

Retrieves the current assignemnt identifier.

Returns:

The current assignment identifier.

getAssignmentCreateTime

java.util.Date getAssignmentCreateTime()

Retrieves the date when the task was assigned.

Returns:

The date when the task was assigned.

getAssignmentUpdateTime

java.util.Date getAssignmentUpdateTime()

Retrieves the date when the task was updated.

Returns:

The date when the task was updated.

getPriority

short getPriority()

Retrieves the priority for this task. The possible priority values are provided in com.adobe.idp.taskmanager.dsc.client.task.CreateTaskInfo#PriorityValues.

Returns:

The priority for this task.

See Also:

com.adobe.idp.taskmanager.dsc.client.task.CreateTaskInfo#PriorityValues

getImageTicket

ImageTicket getImageTicket()

Retrieves an image ticket for this task. You can use the serialized value of the image ticket to construct a new one. You can retrieve a document for the image by calling TaskManager.getImage().

Returns:

The image ticket for this task.

isOutOfOfficeEligible

boolean isOutOfOfficeEligible()

Retrieves whehter or not this task is eligable for Out Of Office designation

Returns:

true, if the task is eligable for Out Of Office designation

getDeadlineInfo

TaskTimerInfo getDeadlineInfo()

Deprecated. - not implemented

Retrieves the deadlineInfo for this task.

Returns:

The deadlineInfo for this task.

getEscalationInfo

TaskTimerInfo getEscalationInfo()

Deprecated. - not implemented

Retrieves the escalationInfo for this task.

Returns:

The escalationInfo for this task.

getFirstReminderInfo

TaskTimerInfo getFirstReminderInfo()

Deprecated. - not implemented

Retrieves the firstReminderInfo for this task.

Returns:

The firstReminderInfo for this task.

getRepeatReminderInfo

TaskTimerInfo getRepeatReminderInfo()

Retrieves the RepeatReminderInfo for this task.

Returns:

The RepeatReminderInfo for this task.

getTaskUIOptions

TaskUIOptions getTaskUIOptions()

Retrieves the specific taskUI options for this task.

Returns:

a populated TaskUIOptions class

getParticipantIPAddress

java.lang.String getParticipantIPAddress()

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

Returns:

the IP Address

getCompletionNote

java.lang.String getCompletionNote()

returns a completion note for this task, if one was saved

Returns:

the completion note for the task.

getSLATargetDate

java.util.Date getSLATargetDate()

returns the SLA target date for this task

Returns:

the sla target date or null if none set.