public class TaskInfo extends Object implements ITaskInfo, ITaskExtendedInfo
ITaskInfo
and ITaskExtendedInfo
OPERATION_ACCEPTED, OPERATION_CREATED, OPERATION_DELEGATION_RULE, OPERATION_DIST_FILTER_RULE, OPERATION_DIST_RULE, OPERATION_ERROR, OPERATION_RESUME, OPERATION_REVERTED, OPERATION_SCHEDULE_RULE, OPERATION_SUSPEND, OPERATION_TRIGGER_RULE, OPERATION_UNACCEPTED, OPERATION_UPDATE, PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_LOW, PRIORITY_MEDIUM, PRIORITY_NONE, STATUS_ACTIVE, STATUS_CANCELLED, STATUS_COMPLETED, STATUS_ERROR, STATUS_EXPIRED, STATUS_NEW, STATUS_SCHEDULED, STATUS_SUSPENDED, STATUS_UNDEFINED, TASK_AUDIT_VOTE, TASK_DATA_BINDING, TASK_DATA_BINDING_PREFIX, TASK_DATA_PROPERTY_PREFIX, TASK_FIELD_ACCEPT_BY_CSV, TASK_FIELD_ACCEPT_BY_NAME, TASK_FIELD_ACCEPT_BY_URI, TASK_FIELD_ACCEPTED_BY_CURRENT, TASK_FIELD_ACCEPTED_BY_LIST, TASK_FIELD_ASSIGNED_TO_CSV, TASK_FIELD_ASSIGNED_TO_LIST, TASK_FIELD_ASSIGNED_TO_NAME, TASK_FIELD_ASSIGNED_TO_URI, TASK_FIELD_ATTRIBUTES, TASK_FIELD_AUDIT_CONTEXT, TASK_FIELD_CHILD_TASK_COUNT, TASK_FIELD_COLLABORATION_PROCESS_ID, TASK_FIELD_COLLABORATION_STEP_ID, TASK_FIELD_CREATED_BY, TASK_FIELD_CREATED_BY_NAME, TASK_FIELD_CREATED_BY_URI, TASK_FIELD_CREATED_DATE, TASK_FIELD_CUSTOM_TASK_ID, TASK_FIELD_DELEGATED_FROM_LIST, TASK_FIELD_DELEGATED_TO_LIST, TASK_FIELD_DESCRIPTION, TASK_FIELD_ERROR_CODE, TASK_FIELD_ERROR_MESSAGE, TASK_FIELD_EXPIRE_DATE, TASK_FIELD_FOR_PROCESS, TASK_FIELD_IS_MANDATORY, TASK_FIELD_IS_VOTABLE, TASK_FIELD_LAST_ACCEPTED_BY, TASK_FIELD_LAST_ACCEPTED_BY_NAME, TASK_FIELD_LAST_ACCEPTED_DATE, TASK_FIELD_LAST_MODIFIED_BY, TASK_FIELD_LAST_MODIFIED_BY_NAME, TASK_FIELD_LAST_MODIFIED_BY_URI, TASK_FIELD_LAST_MODIFIED_DATE, TASK_FIELD_NAME, TASK_FIELD_PARENT_TASK_ID, TASK_FIELD_PRIORITY, TASK_FIELD_PRIORITY_NAME, TASK_FIELD_PROCESS_INSTANCE_ID, TASK_FIELD_PROCESS_ITERATION, TASK_FIELD_PROCESS_MODEL_ID, TASK_FIELD_PROCESS_MODEL_VERSION, TASK_FIELD_PROCESSED_RULES_LIST, TASK_FIELD_STATUS, TASK_FIELD_STATUS_NAME, TASK_FIELD_STEP_ID, TASK_FIELD_STEP_ITERATION, TASK_FIELD_TASK_DATA, TASK_FIELD_TASK_ID, TASK_FIELD_TASK_SCHEDULE_DATE, TASK_FIELD_TASK_TYPE_ID, TASK_FIELD_TASK_TYPE_NAME, TASK_FIELD_TASK_TYPE_URI, TASK_FIELD_TASK_URL, TASK_FIELD_UNACCEPT_FROM_NAME, TASK_FIELD_UNACCEPT_FROM_URI, TASK_FIELD_VERSION, TASK_INFO_BINDING, TASK_INFO_BINDING_PREFIX, TASK_OPERATION_ACCEPTED, TASK_OPERATION_ASSIGNMENT_CHANGED, TASK_OPERATION_ATTACHMENT_ADDED, TASK_OPERATION_ATTACHMENT_DELETED, TASK_OPERATION_ATTACHMENT_UPDATED, TASK_OPERATION_CANCEL, TASK_OPERATION_COMMENT_ADDED, TASK_OPERATION_COMMENT_DELETED, TASK_OPERATION_COMMENT_UPDATED, TASK_OPERATION_COMPLETE, TASK_OPERATION_CREATED, TASK_OPERATION_DELEGATION_CHANGED, TASK_OPERATION_DELEGATION_RULE_FIRED, TASK_OPERATION_DISTRIBUTION_RULE_FIRED, TASK_OPERATION_ERROR, TASK_OPERATION_EXPIRE, TASK_OPERATION_NOTIFICATION, TASK_OPERATION_REPLY, TASK_OPERATION_RESUME, TASK_OPERATION_REVERTED, TASK_OPERATION_ROLLEDBACK, TASK_OPERATION_SCHEDULE_RULE_FIRED, TASK_OPERATION_SINK_REQUEST, TASK_OPERATION_START, TASK_OPERATION_STOP, TASK_OPERATION_SUSPEND, TASK_OPERATION_TRIGGER_RULE_FIRED, TASK_OPERATION_UNACCEPTED, TASK_OPERATION_UNHANDLED_ERROR, TASK_OPERATION_UPDATE, TASK_OPERATION_VOTE, TASK_PRIORITY_CRITICAL, TASK_PRIORITY_HIGH, TASK_PRIORITY_LOW, TASK_PRIORITY_MEDIUM, TASK_PRIORITY_NONE, TASK_STATUS_ACTIVE, TASK_STATUS_CANCELLED, TASK_STATUS_COMPLETED, TASK_STATUS_ERROR, TASK_STATUS_EXPIRED, TASK_STATUS_NEW, TASK_STATUS_SCHEDULED, TASK_STATUS_SUSPENDED, TASK_STATUS_UNDEFINED, TASK_TABLE_TASK, TASK_TABLE_TASK_INBOX, TASK_TAGS
ACCEPT_OTHERS_RIGHT, ACCEPT_RIGHT, ASSIGN_RIGHT, ATTRIBUTE_CALLBACK_DATA, ATTRIBUTE_CALLBACK_SERVICE, ATTRIBUTE_RULE_SET, CALLBACK_TASK_CALLBACK_DATA, CALLBACK_TASK_COMPLETION_INFO, CALLBACK_TASK_DATA, CONFIG_PORTLET_ALIAS, DELETE_RIGHT, EDA_MASK_TASK_CREATED, EDA_MASK_TASK_DELETED, EDA_MASK_TASK_UPDATED, MODIFY_PERMISSION_RIGHT, MODIFY_TASK_DATA_RIGHT, MODIFY_TASK_INFO_RIGHT, PROCESS_AUDIT_POOL_NAME, PROCESS_PRE_TDE_STEP, PROPERTY_TASK_ID, PRT_STEP_CANCEL, PRT_STEP_COMPLETE, PRT_STEP_EXPIRE, PRT_STEP_FAIL, PRT_TASK_ANALYTICS_ENABLED, PRT_TASK_AUDIT_ENABLED, QUEUE_TASK_RIGHT, ROLLBACK_RIGHT, RULE_ATTR_BUSINESS_RULES, RULE_ATTR_CHECK_TIME, RULE_ATTR_DELEGATION_SOURCE, RULE_ATTR_DO_NOT_FIRE, RULE_ATTR_ERROR_CODE, RULE_ATTR_ERROR_MESSAGE, RULE_ATTR_EXPAND_ROLE_MEMBERS, RULE_ATTR_EXPIRING, RULE_ATTR_FIRE_ONCE, RULE_ATTR_FROM_TIMESTAMP, RULE_ATTR_PRINCIPAL_TYPES, RULE_ATTR_PRINCIPAL_TYPES_DELIM, RULE_ATTR_RESULT_TYPE, RULE_ATTR_RULE_SET, RULE_ATTR_RULE_TYPE, RULE_ATTR_RUNNING, RULE_ATTR_SCHEDULE_DATE_BEAN, RULE_ATTR_START_TIME, RULE_ATTR_TASK_DEF_URI, RULE_ATTR_TO_TIMESTAMP, RULE_ATTR_WORKLOAD_PROVIDER, RULE_ATTR_WORKLOAD_PROVIDER_TYPE, RULE_COMMENTS, RULE_CONTEXT_CHANGE_RULES, RULE_CONTEXT_ROUTING_RULES, RULE_CONTEXT_SYSTEM_OBJECT, RULE_CURRENT_TASK, RULE_CURRENT_TASK_EXTENDED, RULE_FACES_CONTEXT, RULE_NEW_CHILD_TASK, RULE_NEW_TASK, RULE_OLD_TASK, RULE_PARENT_TASK, RULE_PRINCIPAL, RULE_RESULT_CANCEL, RULE_RESULT_COMPLETE, RULE_RESULT_ERROR, RULE_RESULT_EXPIRE, RULE_RESULT_EXPRESSION, RULE_RESULT_LAST_ACCEPTED_BY, RULE_RESULT_PRINCIPALS, RULE_RESULT_REPLY, RULE_RESULT_STOP, RULE_ROLE, RULE_TYPE_CHANGE, RULE_TYPE_DELEGATION, RULE_TYPE_DISTRIBUTION, RULE_TYPE_FILTER, RULE_TYPE_SCHEDULE, RULE_USER, START_STOP_RIGHT, STATUS_OUTDATED, STORAGE_ROOT, STORAGE_TYPE_COLLABORATION_PROCESS, STORAGE_TYPE_NAME_COLLABORATION_PROCESS, STORAGE_TYPE_NAME_PREFIX, STORAGE_TYPE_NAME_PROCESS, STORAGE_TYPE_NAME_PROCESS_RULESET, STORAGE_TYPE_PATTERN, STORAGE_TYPE_PROCESS, STORAGE_TYPE_PROCESS_RULESET, STORAGE_TYPE_TASK, TASK_ATTACHMENTS_FOLDER, TASK_ATTACHMENTS_FOLDER_TYPE, TASK_ATTACHMENTS_RELATION, TASK_AUDIT_DELEGATED_BY, TASK_AUDIT_DIFFERENCE, TASK_AUDIT_PROPERTIES, TASK_COMMENTS_FOLDER, TASK_COMMENTS_FOLDER_TYPE, TASK_COMMENTS_RELATION, TASK_DEFINITION_STORAGE, TASK_DETAILS_PAGE, TASK_DETAILS_PORTLET, TASK_FIELD_CONTRIBUTED_BY_LIST, TASK_GLOBAL_DISTRIBUTION_RULES, TASK_GLOBAL_SCHEDULE_RULES, TASK_GLOBAL_TRIGGER_RULES, TASK_RULES_STORAGE, TASK_SEARCH_RAW_WHERE_CLAUSE, TASK_SEARCH_RAW_WHERE_CLAUSE_PREFIX, TASK_STATUS_OUTDATED, TASK_STORAGE, VIEW_TASK_AUDIT_RIGHT, VIEW_TASK_DATA_RIGHT, VIEW_TASK_INFO_RIGHT
Constructor and Description |
---|
TaskInfo() |
Modifier and Type | Method and Description |
---|---|
String[] |
getAcceptedByList()
Returns list of users who currently accepted the task
|
String[] |
getAssignedToList()
Returns list of principals (users, groups, roles) who this task is
assigned to
|
Map<String,Object> |
getChangedProperties()
Returns map of changed properties with the task field name defined in
ITaskConstants as the key and changed value as the value |
String |
getCollaborationProcessID()
Returns ID of ad-hoc workflow process for this task
|
String |
getCollaborationStepID()
Returns ID of ad-hoc workflow process step for this task
|
String |
getCreatedBy()
Returns user ID (name) of the user who created the task
|
Date |
getCreatedDate()
Returns task created date
|
String |
getCustomTaskID()
Returns Task custom ID
|
String |
getDelegatedBy() |
String[] |
getDelegatedByList()
Returns list of rule IDs which delegated the task.
|
String |
getDelegatedFrom()
Returns Determines and returns UID of the principal who has delegated
current task to the current user.
|
String[] |
getDelegatedFromList()
Returns list of principals (users, groups, roles) who delegated this
task.
|
String[] |
getDelegatedToList()
Returns list of principals (users, groups, roles) whom this task is
delegated.
|
Map<String,String> |
getDelegationMap()
Returns Returns a map of delegations for the current task.
|
String |
getDescription()
Returns task description
|
String |
getErrorCode()
Returns Error code in the case of task be in the 'error' state
|
String |
getErrorMessage()
Returns Error message in the case of task be in the 'error' state
|
Date |
getExpireDate()
Returns expiration date for this task if any
|
Integer |
getIsMandatory()
Returns If the child task is mandatory or not
|
Integer |
getIsVotable()
Returns if the task is votable or not
|
String |
getLastAcceptedBy()
Returns user ID (name) of the user who last accepted the task
|
Date |
getLastAcceptedDate()
Returns task last accepted date if any
|
String |
getLastModifiedBy()
Returns user ID of the user who last modified the task
|
Date |
getLastModifiedDate()
Returns task last modified date
|
String |
getName()
Returns task name
|
String |
getParentTaskID()
Returns reference task ID for parent task.
|
String |
getPriority()
Returns task priority
|
String |
getProcessInstanceID()
Returns Process instance ID which spawned this task
|
int |
getProcessIteration()
Returns Process Iteration of owning process
|
String |
getProcessModelID()
Returns Process Model ID of owning process
|
String |
getProcessModelVersion()
Returns Process Model Version of owning process
|
String |
getReferenceTaskIDForUser(String user)
Returns reference taskID specific for a given user (like when task was
added to the user through some other task).
|
boolean |
getRunning() |
String |
getStatus()
Returns task status
|
String |
getStepID()
Returns Process stepID for this task
|
int |
getStepIteration()
Returns Step iteration of owning process
|
String |
getTaskDetailsPageID()
Returns default task details page alias
|
String |
getTaskID()
Returns the unique ID assigned to the task instance
|
Date |
getTaskScheduleDate()
Returns task schedule start date
|
String |
getTaskTypeID()
Returns the unique task type definition ID
|
String |
getTaskURL()
Returns url pointer to this task
|
int |
getTaskVersionNumber()
Returns task version number.
|
String |
getTaskViewPortletID()
Returns ID of the task view portlet for this task
|
String |
getTaskVotingTable()
Returns the voting table for the task which contains the voting strategy and its configuration
|
boolean |
isCurrentUserAccepted()
Returns true if current user accepted that task
|
boolean |
isForProcess()
Returns true if this task is part of collaboration process
|
void |
setAcceptedByList(String[] acceptedBy)
Sets list of users who currently accepted the task
|
void |
setAssignedToList(String[] assignedTo)
Sets list of principals who this task is assigned to
|
void |
setCollaborationProcessID(String collaborationProcessID)
Sets ID of ad-hoc workflow process for this task
|
void |
setCollaborationStepID(String stepID)
Sets ID of ad-hoc workflow process step for this task
|
void |
setCreatedDate(Date createdDate)
Sets created date for this task
|
void |
setCustomTaskID(String customTaskID)
Sets custom task ID
|
void |
setDelegatedFromList(String[] delegatedFrom)
Sets list of principals who this task is delegated
|
void |
setDelegatedToList(String[] assignedTo)
Sets list of principals who this task is delegated
|
void |
setDelegationMap(Map<String,String> delegationMap)
Returns Set the delegatedToList and delegatedFromList values from the
contents of a Map.
|
void |
setDescription(String description)
Sets task description
|
void |
setErrorCode(String errorCode)
Sets error code for this task
|
void |
setErrorMessage(String errorMessage)
Sets error message for this task
|
void |
setExpireDate(Date expireDate)
Sets expire date for this task
|
void |
setForProcess(boolean forProcess)
Marks this task to participate in collaboration process
|
void |
setIsMandatory(Integer isMandatory)
Sets If the child task is mandatory or not
|
void |
setIsVotable(Integer isVotable)
Sets if the task is votable or not
|
void |
setName(String name)
Sets task name
|
void |
setParentTaskID(String referenceTaskID)
Sets reference task ID for parent task.
|
void |
setPriority(String priority)
Sets task priority
|
void |
setRunning(boolean running) |
void |
setStatus(String status)
Sets task status
|
void |
setTaskScheduleDate(Date taskScheduleDate)
sets the task schedule start date
|
void |
setTaskVersionNumber(int versionNumber)
Set task version number
|
void |
setTaskVotingTable(String taskVotingTable)
Sets the voting table definition for the task
|
public Date getTaskScheduleDate()
ITaskInfo
getTaskScheduleDate
in interface ITaskInfo
public void setTaskScheduleDate(Date taskScheduleDate)
ITaskInfo
setTaskScheduleDate
in interface ITaskInfo
public Integer getIsMandatory()
ITaskInfo
getIsMandatory
in interface ITaskInfo
public void setIsMandatory(Integer isMandatory)
ITaskInfo
setIsMandatory
in interface ITaskInfo
public String getTaskID()
ITaskInfo
public String getTaskURL()
ITaskInfo
getTaskURL
in interface ITaskInfo
public String getTaskViewPortletID()
ITaskInfo
getTaskViewPortletID
in interface ITaskInfo
public String getTaskTypeID()
ITaskInfo
getTaskTypeID
in interface ITaskInfo
public String[] getAcceptedByList()
ITaskInfo
getAcceptedByList
in interface ITaskInfo
public String[] getAssignedToList()
ITaskInfo
getAssignedToList
in interface ITaskInfo
public String getCreatedBy()
ITaskInfo
getCreatedBy
in interface ITaskInfo
public Date getCreatedDate()
ITaskInfo
getCreatedDate
in interface ITaskInfo
public String getDescription()
ITaskInfo
getDescription
in interface ITaskInfo
public String getLastAcceptedBy()
ITaskInfo
getLastAcceptedBy
in interface ITaskInfo
public String getLastModifiedBy()
ITaskInfo
getLastModifiedBy
in interface ITaskInfo
public Date getLastModifiedDate()
ITaskInfo
getLastModifiedDate
in interface ITaskInfo
public Date getLastAcceptedDate()
ITaskInfo
getLastAcceptedDate
in interface ITaskInfo
public String getPriority()
ITaskInfo
getPriority
in interface ITaskInfo
public boolean getRunning()
public String getStatus()
ITaskInfo
public void setDescription(String description)
ITaskInfo
setDescription
in interface ITaskInfo
description
- the new task descriptionpublic void setName(String name)
ITaskInfo
public void setPriority(String priority)
ITaskInfo
setPriority
in interface ITaskInfo
priority
- the new task prioritypublic void setRunning(boolean running)
public void setStatus(String status)
ITaskInfo
public Date getExpireDate()
ITaskInfo
getExpireDate
in interface ITaskInfo
public void setExpireDate(Date expireDate) throws Exception
ITaskInfo
setExpireDate
in interface ITaskInfo
expireDate
- the new expiration dateException
public void setCreatedDate(Date createdDate) throws Exception
ITaskInfo
setCreatedDate
in interface ITaskInfo
createdDate
- the new created dateException
public String getCustomTaskID()
ITaskInfo
getCustomTaskID
in interface ITaskInfo
public void setCustomTaskID(String customTaskID)
ITaskInfo
setCustomTaskID
in interface ITaskInfo
customTaskID
- custom task IDpublic String getProcessInstanceID()
ITaskInfo
getProcessInstanceID
in interface ITaskInfo
public String getStepID()
ITaskInfo
public int getProcessIteration()
ITaskInfo
getProcessIteration
in interface ITaskInfo
public String getProcessModelID()
ITaskInfo
getProcessModelID
in interface ITaskInfo
public String getProcessModelVersion()
ITaskInfo
getProcessModelVersion
in interface ITaskInfo
public int getStepIteration()
ITaskInfo
getStepIteration
in interface ITaskInfo
public void setAcceptedByList(String[] acceptedBy) throws Exception
ITaskInfo
setAcceptedByList
in interface ITaskInfo
acceptedBy
- new list of users who currently accepted the taskException
public void setAssignedToList(String[] assignedTo) throws Exception
ITaskInfo
setAssignedToList
in interface ITaskInfo
assignedTo
- list of principals who this task is assigned toException
public String[] getDelegatedToList()
ITaskInfo
ITaskInfo.getDelegatedFromList()
getDelegatedToList
in interface ITaskInfo
public void setDelegatedToList(String[] assignedTo) throws Exception
ITaskInfo
setDelegatedToList
in interface ITaskInfo
Exception
public String[] getDelegatedByList()
ITaskInfo
ITaskInfo.getDelegatedToList()
and
ITaskInfo.getDelegatedFromList()
. If task was not delegated by the rule,
but manually the corresponding entry in this list if null, otherwise it
will contain corresponding rule IDgetDelegatedByList
in interface ITaskInfo
public String[] getDelegatedFromList()
ITaskInfo
ITaskInfo.getDelegatedToList()
getDelegatedFromList
in interface ITaskInfo
public String getDelegatedFrom() throws ContentProviderException
ITaskInfo
getDelegatedFrom
in interface ITaskInfo
ContentProviderException
public void setDelegatedFromList(String[] delegatedFrom) throws Exception
ITaskInfo
setDelegatedFromList
in interface ITaskInfo
Exception
public Map<String,String> getDelegationMap()
ITaskInfo
getDelegationMap
in interface ITaskInfo
public void setDelegationMap(Map<String,String> delegationMap) throws Exception
ITaskInfo
setDelegationMap
in interface ITaskInfo
Exception
public Map<String,Object> getChangedProperties()
ITaskExtendedInfo
ITaskConstants
as the key and changed value as the valuegetChangedProperties
in interface ITaskExtendedInfo
public int getTaskVersionNumber() throws Exception
ITaskExtendedInfo
getTaskVersionNumber
in interface ITaskExtendedInfo
Exception
public void setTaskVersionNumber(int versionNumber) throws Exception
ITaskExtendedInfo
setTaskVersionNumber
in interface ITaskExtendedInfo
versionNumber
- task version numberException
public String getErrorCode()
ITaskInfo
getErrorCode
in interface ITaskInfo
public String getErrorMessage()
ITaskInfo
getErrorMessage
in interface ITaskInfo
public void setErrorCode(String errorCode) throws Exception
ITaskInfo
setErrorCode
in interface ITaskInfo
errorCode
- error code for this taskException
public void setErrorMessage(String errorMessage) throws Exception
ITaskInfo
setErrorMessage
in interface ITaskInfo
errorMessage
- error message for this taskException
public boolean isCurrentUserAccepted() throws Exception
ITaskInfo
isCurrentUserAccepted
in interface ITaskInfo
Exception
public String getTaskDetailsPageID()
ITaskInfo
getTaskDetailsPageID
in interface ITaskInfo
public String getCollaborationProcessID()
ITaskInfo
getCollaborationProcessID
in interface ITaskInfo
public String getParentTaskID()
ITaskInfo
getParentTaskID
in interface ITaskInfo
public boolean isForProcess() throws Exception
ITaskInfo
isForProcess
in interface ITaskInfo
Exception
public void setCollaborationProcessID(String collaborationProcessID) throws Exception
ITaskInfo
setCollaborationProcessID
in interface ITaskInfo
collaborationProcessID
- ID of collaboration process for this taskException
public String getCollaborationStepID()
ITaskInfo
getCollaborationStepID
in interface ITaskInfo
public void setCollaborationStepID(String stepID)
ITaskInfo
setCollaborationStepID
in interface ITaskInfo
stepID
- ID of collaboration process for this taskpublic void setForProcess(boolean forProcess) throws Exception
ITaskInfo
setForProcess
in interface ITaskInfo
forProcess
- should be true if this task needs to be marked to participate
in collaboration processException
public void setParentTaskID(String referenceTaskID) throws Exception
ITaskInfo
setParentTaskID
in interface ITaskInfo
referenceTaskID
- reference task ID for parent taskException
public String getReferenceTaskIDForUser(String user)
ITaskInfo
getReferenceTaskIDForUser
in interface ITaskInfo
user
- given userpublic Integer getIsVotable()
ITaskInfo
getIsVotable
in interface ITaskInfo
public void setIsVotable(Integer isVotable)
ITaskInfo
setIsVotable
in interface ITaskInfo
public String getTaskVotingTable()
ITaskInfo
getTaskVotingTable
in interface ITaskInfo
public void setTaskVotingTable(String taskVotingTable)
ITaskInfo
setTaskVotingTable
in interface ITaskInfo