public class TaskSummary extends TaskProperties
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
SORT_BY_ACCEPTED_TIME |
static java.lang.Integer |
SORT_BY_ACCEPTMODE |
static java.lang.Integer |
SORT_BY_ASSIGNED_TIME |
static java.lang.Integer |
SORT_BY_COMPLETED_TIME |
static java.lang.Integer |
SORT_BY_DESCRIPTION |
static java.lang.Integer |
SORT_BY_ELAPSED
Deprecated.
Use
SORT_BY_ELAPSED_MILLISECONDS instead. |
static java.lang.Integer |
SORT_BY_ELAPSED_MILLISECONDS |
static java.lang.Integer |
SORT_BY_ID |
static java.lang.Integer |
SORT_BY_NAME |
static java.lang.Integer |
SORT_BY_ONE_USER_ASSIGNED |
static java.lang.Integer |
SORT_BY_OWNERS |
static java.lang.Integer |
SORT_BY_PRIORITY_ID
Deprecated.
Use
SORT_BY_PRIORITY_NAME instead, which produces the same results. |
static java.lang.Integer |
SORT_BY_PRIORITY_NAME |
static java.lang.Integer |
SORT_BY_PROCESS_INITIATOR |
static java.lang.Integer |
SORT_BY_PROCESS_NAME |
static java.lang.Integer |
SORT_BY_PROCESSID |
static java.lang.Integer |
SORT_BY_STATUS |
static java.lang.Integer |
TASK_STATUS_ABORTED
Deprecated.
|
static java.lang.Integer |
TASK_STATUS_ACCEPTED
A task receives this status when it is accepted by a user.
|
static java.lang.Integer |
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.
|
static java.lang.Integer |
TASK_STATUS_CANCELLED
A final status indicating that a task has been canceled.
|
static java.lang.Integer |
TASK_STATUS_COMPLETED
A final status indicating that a task has been completed.
|
static java.lang.Integer |
TASK_STATUS_ERROR
A status indicating that an error has occurred during execution of a legacy web
service activity.
|
static java.lang.Integer |
TASK_STATUS_NOT_STARTED
A status indicating that a task has been created but its initialization has not yet
begun.
|
static java.lang.Integer |
TASK_STATUS_PAUSED
A status indicating that a task has been paused.
|
static java.lang.Integer |
TASK_STATUS_PAUSED_BY_EXCEPTION
A status indicating that a task has been paused by exception.
|
static java.lang.Integer |
TASK_STATUS_RUNNING
A status indicating that a legacy web service activity is running.
|
static java.lang.Integer |
TASK_STATUS_SKIPPED
A final status indicating that a task has been skipped.
|
static java.lang.Integer |
TASK_STATUS_SUBMITTED
A status indicating that a legacy web service activity has been submitted.
|
static java.lang.Integer |
TASK_STATUS_UNATTENDED
A status indicating that an unattended task has finished initialization and is either
executing or about to be executed.
|
Constructor and Description |
---|
TaskSummary() |
Modifier and Type | Method and Description |
---|---|
java.sql.Timestamp |
getAcceptedTime()
Returns the time at which the task was accepted or
null if
it has not yet been accepted. |
java.lang.Integer |
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.
|
java.sql.Timestamp |
getAssignedTime()
Returns the time at which the task was assigned or
null if
it has not yet been assigned. |
Assignment.Assignee[] |
getAssignees()
Returns the users/groups that the task is assigned to.
|
java.lang.Long |
getChildProcessId()
If this task is a Sub-Process or Linked-Process node, returns
the id of the child process that this task references; otherwise returns
null . |
java.sql.Timestamp |
getCompletedTime()
Returns the time at which the task was completed, or
null
if it has not yet been completed. |
java.lang.Double |
getElapsed()
Returns the amount of time (in days) since the task was started.
|
java.lang.Long |
getElapsedMilliseconds()
Deprecated.
Use
getElapsed() instead. |
ProcessException |
getException()
If the task is paused by exception, returns the exception on
the task; otherwise, returns
null . |
boolean |
getFavorite() |
int |
getFormCapability()
Get the form capabilities required for this task (FormConfig CAPABILITY_* constants merged together via bitwise 'or').
|
boolean |
getIsAttended()
Returns
true if the task is attended, and false
otherwise |
java.lang.String[] |
getOwners()
Returns the usernames of the owners of the task.
|
NodePermissions |
getPermissions()
Return the permissions for the task.
|
java.sql.Timestamp |
getProcessDeadline() |
java.lang.Long |
getProcessId()
Returns the id of the process that the task is part of.
|
java.lang.String |
getProcessInitiator()
Returns the username of the initiator of the process that this task
is part of.
|
java.lang.String |
getProcessName()
Returns the name of the process that this task is part of.
|
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.
|
java.lang.Integer |
getStatus()
Returns the status of the task, which is one of the TASK_STATUS_XXX
constants defined by this class.
|
java.lang.String |
getStatusBy()
If the task is paused or cancelled, returns the username of the user
who paused/cancelled the task; otherwise returns
null . |
java.sql.Timestamp |
getStatusTime()
If the task is paused or cancelled, returns the time at which the task
was paused/cancelled; otherwise returns
null . |
java.sql.Timestamp |
getTaskDeadline() |
java.lang.Long |
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.
|
boolean |
isAllowInlineApproval()
Gets whether the task's form supports inline approval in the context user's effective locale.
|
boolean |
isCompleted()
Returns
true if the task has been completed, and
false otherwise. |
boolean |
isInChain() |
boolean |
isMobileEnabled()
Gets whether the task's form is mobile enabled in the context user's effective locale.
|
boolean |
isMutablePriority()
Returns
true if the priority of this task is mutable (ie
can be changed), and false otherwise. |
boolean |
isOneUserAssigned()
Returns
true if the task is assigned to exactly one user,
and false otherwise. |
void |
setAcceptedTime(java.sql.Timestamp time_)
See
getAcceptedTime() . |
void |
setAcceptMode(java.lang.Integer mode_)
See
getAcceptMode() . |
void |
setAllowInlineApproval(boolean allowInlineApproval)
The form's inline approval status is set by the system when this bean is returned.
|
void |
setAssignedTime(java.sql.Timestamp time_)
See
getAssignedTime() . |
void |
setAssignees(Assignment.Assignee[] assignees_)
See
getAssignees() . |
void |
setChildProcessId(java.lang.Long childProcessId_)
See
getChildProcessId() . |
void |
setCompletedTime(java.sql.Timestamp time_)
See
getCompletedTime() . |
void |
setElapsed(java.lang.Double elapsed_)
See
getElapsed() . |
void |
setElapsedMilliseconds(java.lang.Long milliseconds_)
Deprecated.
Use
#setElapsed() instead. |
void |
setException(ProcessException exception_)
See
getException() . |
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_)
See
getIsAttended() |
void |
setMobileEnabled(boolean isMobileEnabled)
The form's mobile enabled status is set by the system when this bean is returned.
|
void |
setMutablePriority(boolean mutablePriority_)
See
isMutablePriority() . |
void |
setOneUserAssigned(boolean oneUserAssigned_)
See
isOneUserAssigned() . |
void |
setOwners(java.lang.String[] owners_)
See
getOwners() . |
void |
setPermissions(NodePermissions permissions_)
See
getPermissions() . |
void |
setProcessDeadline(java.sql.Timestamp processDeadline_) |
void |
setProcessId(java.lang.Long id_)
See
getProcessId() . |
void |
setProcessInitiator(java.lang.String initiator_)
|
void |
setProcessName(java.lang.String name_)
See
getProcessName() . |
void |
setProcessStatus(int processStatus_)
See
getProcessStatus() . |
void |
setStatus(java.lang.Integer status_)
See
setStatus(Integer) . |
void |
setStatusBy(java.lang.String statusBy_)
See
getStatusBy() . |
void |
setStatusTime(java.sql.Timestamp time_)
See
getStatusTime() . |
void |
setTaskDeadline(java.sql.Timestamp taskDeadline_) |
void |
setTemplateId(java.lang.Long id_)
See
getTemplateId() . |
getDescription, getDisplayName, getPriority, getUuid, setDescription, setDisplayName, setPriority, setUuid, toString
public static final java.lang.Integer TASK_STATUS_ASSIGNED
public static final java.lang.Integer TASK_STATUS_ACCEPTED
public static final java.lang.Integer TASK_STATUS_COMPLETED
public static final java.lang.Integer TASK_STATUS_NOT_STARTED
public static final java.lang.Integer TASK_STATUS_CANCELLED
public static final java.lang.Integer TASK_STATUS_PAUSED
public static final java.lang.Integer TASK_STATUS_UNATTENDED
@Deprecated public static final java.lang.Integer TASK_STATUS_ABORTED
public static final java.lang.Integer TASK_STATUS_PAUSED_BY_EXCEPTION
public static final java.lang.Integer TASK_STATUS_SUBMITTED
public static final java.lang.Integer TASK_STATUS_RUNNING
public static final java.lang.Integer TASK_STATUS_ERROR
public static final java.lang.Integer TASK_STATUS_SKIPPED
public static final java.lang.Integer SORT_BY_NAME
public static final java.lang.Integer SORT_BY_STATUS
public static final java.lang.Integer SORT_BY_PRIORITY_NAME
public static final java.lang.Integer SORT_BY_ASSIGNED_TIME
public static final java.lang.Integer SORT_BY_ACCEPTED_TIME
public static final java.lang.Integer SORT_BY_ELAPSED_MILLISECONDS
public static final java.lang.Integer SORT_BY_COMPLETED_TIME
public static final java.lang.Integer SORT_BY_PROCESS_NAME
public static final java.lang.Integer SORT_BY_PROCESS_INITIATOR
public static final java.lang.Integer SORT_BY_ID
public static final java.lang.Integer SORT_BY_DESCRIPTION
public static final java.lang.Integer SORT_BY_OWNERS
public static final java.lang.Integer SORT_BY_PROCESSID
public static final java.lang.Integer SORT_BY_ACCEPTMODE
public static final java.lang.Integer SORT_BY_ONE_USER_ASSIGNED
@Deprecated public static final java.lang.Integer SORT_BY_ELAPSED
SORT_BY_ELAPSED_MILLISECONDS
instead.@Deprecated public static final java.lang.Integer SORT_BY_PRIORITY_ID
SORT_BY_PRIORITY_NAME
instead, which produces the same results.public int getProcessStatus()
public void setProcessStatus(int processStatus_)
getProcessStatus()
.public ProcessException getException()
null
.public void setException(ProcessException exception_)
getException()
.public java.lang.Long getChildProcessId()
null
.public void setChildProcessId(java.lang.Long childProcessId_)
getChildProcessId()
.public java.sql.Timestamp getAcceptedTime()
null
if
it has not yet been accepted.public void setAcceptedTime(java.sql.Timestamp time_)
getAcceptedTime()
.public java.lang.Integer getAcceptMode()
public void setAcceptMode(java.lang.Integer mode_)
getAcceptMode()
.public java.sql.Timestamp getAssignedTime()
null
if
it has not yet been assigned.public void setAssignedTime(java.sql.Timestamp time_)
getAssignedTime()
.public java.sql.Timestamp getCompletedTime()
null
if it has not yet been completed.public void setCompletedTime(java.sql.Timestamp time_)
getCompletedTime()
.@Deprecated public java.lang.Long getElapsedMilliseconds()
getElapsed()
instead.@Deprecated public void setElapsedMilliseconds(java.lang.Long milliseconds_)
#setElapsed()
instead.public java.lang.Double getElapsed()
public void setElapsed(java.lang.Double elapsed_)
getElapsed()
.public java.lang.String[] getOwners()
public void setOwners(java.lang.String[] owners_)
getOwners()
.public java.lang.Long getProcessId()
public void setProcessId(java.lang.Long id_)
getProcessId()
.public java.lang.String getProcessName()
public void setProcessName(java.lang.String name_)
getProcessName()
.public java.lang.Integer getStatus()
public void setStatus(java.lang.Integer status_)
setStatus(Integer)
.public java.lang.String getProcessInitiator()
public void setProcessInitiator(java.lang.String initiator_)
public boolean isOneUserAssigned()
true
if the task is assigned to exactly one user,
and false
otherwise.public void setOneUserAssigned(boolean oneUserAssigned_)
isOneUserAssigned()
.public boolean getIsAttended()
true
if the task is attended, and false
otherwisepublic void setIsAttended(boolean isAttended_)
getIsAttended()
public boolean isCompleted()
true
if the task has been completed, and
false
otherwise.public Assignment.Assignee[] getAssignees()
public void setAssignees(Assignment.Assignee[] assignees_)
getAssignees()
.public NodePermissions getPermissions()
public void setPermissions(NodePermissions permissions_)
getPermissions()
.public java.lang.String getStatusBy()
null
.public void setStatusBy(java.lang.String statusBy_)
getStatusBy()
.public java.sql.Timestamp getStatusTime()
null
.public void setStatusTime(java.sql.Timestamp time_)
getStatusTime()
.public java.lang.Long getTemplateId()
public void setTemplateId(java.lang.Long id_)
getTemplateId()
.public boolean isMutablePriority()
true
if the priority of this task is mutable (ie
can be changed), and false
otherwise.public void setMutablePriority(boolean mutablePriority_)
isMutablePriority()
.public boolean getFavorite()
public void setFavorite(boolean favorite_)
public java.sql.Timestamp getProcessDeadline()
public void setProcessDeadline(java.sql.Timestamp processDeadline_)
public java.sql.Timestamp getTaskDeadline()
public void setTaskDeadline(java.sql.Timestamp taskDeadline_)
public boolean isInChain()
public void setInChain(boolean inChain_)
public boolean isAllowInlineApproval()
FormConfig.TASK_ALLOW_INLINE_APPROVAL
flag.FormConfig.getHiddenSections()
public void setAllowInlineApproval(boolean allowInlineApproval)
allowInlineApproval
- whether the task's form supports inline approval in the context
user's effective localeFormConfig.setHiddenSections(java.lang.Integer)
public boolean isMobileEnabled()
FormConfig.FORM_IS_MOBILE_ENABLED
flag.FormConfig.getHiddenSections()
public void setMobileEnabled(boolean isMobileEnabled)
isMobileEnabled
- whether the task's form is mobile enabled in the context user's
effective localeFormConfig.setHiddenSections(java.lang.Integer)
public int getFormCapability()
FormConfig
public void setFormCapability(int formCapability)
formCapability
- bit vectorFormConfig
Copyright © 2003-2024 Appian Corporation. All Rights Reserved.