Package com.appiancorp.suiteapi.process
Class TaskSummary
java.lang.Object
com.appiancorp.suiteapi.common.Identity
com.appiancorp.suiteapi.process.TaskProperties
com.appiancorp.suiteapi.process.TaskSummary
- All Implemented Interfaces:
LocalId
,Serializable
- Direct Known Subclasses:
TaskDetails
Holds a high-level summary for a task.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Integer
static final Integer
static final Integer
static final Integer
static final Integer
static final Integer
Deprecated.static final Integer
static final Integer
static final Integer
static final Integer
static final Integer
static final Integer
Deprecated.UseSORT_BY_PRIORITY_NAME
instead, which produces the same results.static final Integer
static final Integer
static final Integer
static final Integer
static final Integer
static final Integer
Deprecated.static final Integer
A task receives this status when it is accepted by a user.static final Integer
A status indicating that a task's initialization is complete and the task is ready to be accepted, but no user has accepted it yet.static final Integer
A final status indicating that a task has been canceled.static final Integer
A final status indicating that a task has been completed.static final Integer
A status indicating that an error has occurred during execution of a legacy web service activity.static final Integer
A status indicating that a task has been created but its initialization has not yet begun.static final Integer
A status indicating that a task has been paused.static final Integer
A status indicating that a task has been paused by exception.static final Integer
A status indicating that a legacy web service activity is running.static final Integer
A final status indicating that a task has been skipped.static final Integer
A status indicating that a legacy web service activity has been submitted.static final Integer
A status indicating that an unattended task has finished initialization and is either executing or about to be executed. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the time at which the task was accepted ornull
if it has not yet been accepted.Returns the accept mode of the task: 0 is Auto Accept Always, 1 is Auto Accept When Assigned, and 2 is Manually Accept Always.Returns the time at which the task was assigned ornull
if it has not yet been assigned.Returns the users/groups that the task is assigned to.If this task is a Sub-Process or Linked-Process node, returns the id of the child process that this task references; otherwise returnsnull
.Returns the time at which the task was completed, ornull
if it has not yet been completed.Returns the amount of time (in days) since the task was started.Deprecated.UsegetElapsed()
instead.If the task is paused by exception, returns the exception on the task; otherwise, returnsnull
.boolean
int
Get the form capabilities required for this task (FormConfig CAPABILITY_* constants merged together via bitwise 'or').boolean
Returnstrue
if the task is attended, andfalse
otherwiseString[]
Returns the usernames of the owners of the task.Return the permissions for the task.Returns the id of the process that the task is part of.Returns the username of the initiator of the process that this task is part of.Returns the name of the process that this task is part of.int
Returns the status of the process that this task is part of; using this property could result in race conditions if the process status is updated after the task summary object is retrieved.Returns the status of the task, which is one of the TASK_STATUS_XXX constants defined by this class.If the task is paused or cancelled, returns the username of the user who paused/cancelled the task; otherwise returnsnull
.If the task is paused or cancelled, returns the time at which the task was paused/cancelled; otherwise returnsnull
.Returns the id of the node (in the process model for the process that the task is part of) that is the "template" for the task.boolean
Gets whether the task's form supports inline approval in the context user's effective locale.boolean
Returnstrue
if the task has been completed, andfalse
otherwise.boolean
boolean
Gets whether the task's form is mobile enabled in the context user's effective locale.boolean
Returnstrue
if the priority of this task is mutable (ie can be changed), andfalse
otherwise.boolean
Returnstrue
if the task is assigned to exactly one user, andfalse
otherwise.void
setAcceptedTime
(Timestamp time_) SeegetAcceptedTime()
.void
setAcceptMode
(Integer mode_) SeegetAcceptMode()
.void
setAllowInlineApproval
(boolean allowInlineApproval) The form's inline approval status is set by the system when this bean is returned.void
setAssignedTime
(Timestamp time_) SeegetAssignedTime()
.void
setAssignees
(Assignment.Assignee[] assignees_) SeegetAssignees()
.void
setChildProcessId
(Long childProcessId_) SeegetChildProcessId()
.void
setCompletedTime
(Timestamp time_) SeegetCompletedTime()
.void
setElapsed
(Double elapsed_) SeegetElapsed()
.void
setElapsedMilliseconds
(Long milliseconds_) Deprecated.Use#setElapsed()
instead.void
setException
(ProcessException exception_) SeegetException()
.void
setFavorite
(boolean favorite_) void
setFormCapability
(int formCapability) Set the form capabilities required for this task (FormConfig CAPABILITY_* constants merged together via bitwise 'or').void
setInChain
(boolean inChain_) void
setIsAttended
(boolean isAttended_) SeegetIsAttended()
void
setMobileEnabled
(boolean isMobileEnabled) The form's mobile enabled status is set by the system when this bean is returned.void
setMutablePriority
(boolean mutablePriority_) SeeisMutablePriority()
.void
setOneUserAssigned
(boolean oneUserAssigned_) SeeisOneUserAssigned()
.void
SeegetOwners()
.void
setPermissions
(NodePermissions permissions_) SeegetPermissions()
.void
setProcessDeadline
(Timestamp processDeadline_) void
setProcessId
(Long id_) SeegetProcessId()
.void
setProcessInitiator
(String initiator_) void
setProcessName
(String name_) SeegetProcessName()
.void
setProcessStatus
(int processStatus_) SeegetProcessStatus()
.void
SeesetStatus(Integer)
.void
setStatusBy
(String statusBy_) SeegetStatusBy()
.void
setStatusTime
(Timestamp time_) SeegetStatusTime()
.void
setTaskDeadline
(Timestamp taskDeadline_) void
setTemplateId
(Long id_) SeegetTemplateId()
.Methods inherited from class com.appiancorp.suiteapi.process.TaskProperties
getDescription, getDisplayName, getPriority, getUuid, setDescription, setDisplayName, setPriority, setUuid, toString
-
Field Details
-
TASK_STATUS_ASSIGNED
A status indicating that a task's initialization is complete and the task is ready to be accepted, but no user has accepted it yet. -
TASK_STATUS_ACCEPTED
A task receives this status when it is accepted by a user. -
TASK_STATUS_COMPLETED
A final status indicating that a task has been completed. -
TASK_STATUS_NOT_STARTED
A status indicating that a task has been created but its initialization has not yet begun. Spawned tasks that execute sequentially have this status until the preceding task in the sequence is completed. -
TASK_STATUS_CANCELLED
A final status indicating that a task has been canceled. -
TASK_STATUS_PAUSED
A status indicating that a task has been paused. -
TASK_STATUS_UNATTENDED
A status indicating that an unattended task has finished initialization and is either executing or about to be executed. -
TASK_STATUS_ABORTED
Deprecated.This status is not used. -
TASK_STATUS_PAUSED_BY_EXCEPTION
A status indicating that a task has been paused by exception. -
TASK_STATUS_SUBMITTED
A status indicating that a legacy web service activity has been submitted. -
TASK_STATUS_RUNNING
A status indicating that a legacy web service activity is running. -
TASK_STATUS_ERROR
A status indicating that an error has occurred during execution of a legacy web service activity. -
TASK_STATUS_SKIPPED
A final status indicating that a task has been skipped. A task is skipped when its exception flow is taken. -
SORT_BY_NAME
-
SORT_BY_STATUS
-
SORT_BY_PRIORITY_NAME
-
SORT_BY_ASSIGNED_TIME
-
SORT_BY_ACCEPTED_TIME
-
SORT_BY_ELAPSED_MILLISECONDS
-
SORT_BY_COMPLETED_TIME
-
SORT_BY_PROCESS_NAME
-
SORT_BY_PROCESS_INITIATOR
-
SORT_BY_ID
-
SORT_BY_DESCRIPTION
-
SORT_BY_OWNERS
-
SORT_BY_PROCESSID
-
SORT_BY_ACCEPTMODE
-
SORT_BY_ONE_USER_ASSIGNED
-
SORT_BY_ELAPSED
Deprecated.UseSORT_BY_ELAPSED_MILLISECONDS
instead. -
SORT_BY_PRIORITY_ID
Deprecated.UseSORT_BY_PRIORITY_NAME
instead, which produces the same results.
-
-
Constructor Details
-
TaskSummary
public TaskSummary()
-
-
Method Details
-
getProcessStatus
public int getProcessStatus()Returns the status of the process that this task is part of; using this property could result in race conditions if the process status is updated after the task summary object is retrieved. -
setProcessStatus
public void setProcessStatus(int processStatus_) SeegetProcessStatus()
. -
getException
If the task is paused by exception, returns the exception on the task; otherwise, returnsnull
. -
setException
SeegetException()
. -
getChildProcessId
If this task is a Sub-Process or Linked-Process node, returns the id of the child process that this task references; otherwise returnsnull
. -
setChildProcessId
SeegetChildProcessId()
. -
getAcceptedTime
Returns the time at which the task was accepted ornull
if it has not yet been accepted. -
setAcceptedTime
SeegetAcceptedTime()
. -
getAcceptMode
Returns the accept mode of the task: 0 is Auto Accept Always, 1 is Auto Accept When Assigned, and 2 is Manually Accept Always. -
setAcceptMode
SeegetAcceptMode()
. -
getAssignedTime
Returns the time at which the task was assigned ornull
if it has not yet been assigned. -
setAssignedTime
SeegetAssignedTime()
. -
getCompletedTime
Returns the time at which the task was completed, ornull
if it has not yet been completed. -
setCompletedTime
SeegetCompletedTime()
. -
getElapsedMilliseconds
Deprecated.UsegetElapsed()
instead.Returns the amount of time (in ms) since the task was started. -
setElapsedMilliseconds
Deprecated.Use#setElapsed()
instead. -
getElapsed
Returns the amount of time (in days) since the task was started. -
setElapsed
SeegetElapsed()
. -
getOwners
Returns the usernames of the owners of the task. -
setOwners
SeegetOwners()
. -
getProcessId
Returns the id of the process that the task is part of. -
setProcessId
SeegetProcessId()
. -
getProcessName
Returns the name of the process that this task is part of. -
setProcessName
SeegetProcessName()
. -
getStatus
Returns the status of the task, which is one of the TASK_STATUS_XXX constants defined by this class. -
setStatus
SeesetStatus(Integer)
. -
getProcessInitiator
Returns the username of the initiator of the process that this task is part of. -
setProcessInitiator
-
isOneUserAssigned
public boolean isOneUserAssigned()Returnstrue
if the task is assigned to exactly one user, andfalse
otherwise. -
setOneUserAssigned
public void setOneUserAssigned(boolean oneUserAssigned_) SeeisOneUserAssigned()
. -
getIsAttended
public boolean getIsAttended()Returnstrue
if the task is attended, andfalse
otherwise -
setIsAttended
public void setIsAttended(boolean isAttended_) SeegetIsAttended()
-
isCompleted
public boolean isCompleted()Returnstrue
if the task has been completed, andfalse
otherwise. -
getAssignees
Returns the users/groups that the task is assigned to. -
setAssignees
SeegetAssignees()
. -
getPermissions
Return the permissions for the task. -
setPermissions
SeegetPermissions()
. -
getStatusBy
If the task is paused or cancelled, returns the username of the user who paused/cancelled the task; otherwise returnsnull
. -
setStatusBy
SeegetStatusBy()
. -
getStatusTime
If the task is paused or cancelled, returns the time at which the task was paused/cancelled; otherwise returnsnull
. -
setStatusTime
SeegetStatusTime()
. -
getTemplateId
Returns the id of the node (in the process model for the process that the task is part of) that is the "template" for the task. -
setTemplateId
SeegetTemplateId()
. -
isMutablePriority
public boolean isMutablePriority()Returnstrue
if the priority of this task is mutable (ie can be changed), andfalse
otherwise. -
setMutablePriority
public void setMutablePriority(boolean mutablePriority_) SeeisMutablePriority()
. -
getFavorite
public boolean getFavorite() -
setFavorite
public void setFavorite(boolean favorite_) -
getProcessDeadline
-
setProcessDeadline
-
getTaskDeadline
-
setTaskDeadline
-
isInChain
public boolean isInChain() -
setInChain
public void setInChain(boolean inChain_) -
isAllowInlineApproval
public boolean isAllowInlineApproval()Gets whether the task's form supports inline approval in the context user's effective locale. This corresponds to theFormConfig.TASK_ALLOW_INLINE_APPROVAL
flag.- Returns:
- whether the task's form supports inline approval
- See Also:
-
setAllowInlineApproval
public void setAllowInlineApproval(boolean allowInlineApproval) The form's inline approval status is set by the system when this bean is returned. Calling this method has no effect.- Parameters:
allowInlineApproval
- whether the task's form supports inline approval in the context user's effective locale- See Also:
-
isMobileEnabled
public boolean isMobileEnabled()Gets whether the task's form is mobile enabled in the context user's effective locale. This corresponds to theFormConfig.FORM_IS_MOBILE_ENABLED
flag.- Returns:
- whether the task's form is mobile enabled
- See Also:
-
setMobileEnabled
public void setMobileEnabled(boolean isMobileEnabled) The form's mobile enabled status is set by the system when this bean is returned. Calling this method has no effect.- Parameters:
isMobileEnabled
- whether the task's form is mobile enabled in the context user's effective locale- See Also:
-
getFormCapability
public int getFormCapability()Get the form capabilities required for this task (FormConfig CAPABILITY_* constants merged together via bitwise 'or'). This is available only for TaskSummary objects returned by ProcessAnalyticsService (e.g., via getMyTasks). Example: If a form requires UI Expression capabilities, then it returns FormConfig.CAPABILITY_ALLOW_TYPE_UI_EXPRESSION.- Returns:
- form capabilities required
- See Also:
-
setFormCapability
public void setFormCapability(int formCapability) Set the form capabilities required for this task (FormConfig CAPABILITY_* constants merged together via bitwise 'or').- Parameters:
formCapability
- bit vector- See Also:
-
SORT_BY_ELAPSED_MILLISECONDS
instead.