ITaskInfo (webMethods CAF

All Superinterfaces:

ITaskConstants

All Known Implementing Classes:

TaskInfo
```
public interface ITaskInfo
extends ITaskConstants
```
ITaskInfo is the interface representing Task Information.

Field Summary
- Fields inherited from interface com.webmethods.caf.faces.data.task.ITaskConstants
  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_SUSPENDED, STATUS_UNDEFINED, 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_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_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_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_SUSPENDED, TASK_STATUS_UNDEFINED, TASK_TAGS

Method Summary

Methods
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
`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[]`	`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`	`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
`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).
`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
`String`	`getTaskTypeID()` Returns the unique task type definition ID
`String`	`getTaskURL()` Returns url pointer to this task
`String`	`getTaskViewPortletID()` Returns ID of the task view portlet for this task
`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 collaborationStepID)` Sets ID of ad-hoc workflow process step 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[] delegatedTo)` Sets list of principals who this task is delegated
`void`	`setDelegationMap(Map 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`	`setName(String name)` Sets task name
`void`	`setParentTaskID(String parentTaskID)` Sets reference task ID for parent task.
`void`	`setPriority(String priority)` Sets task priority
`void`	`setStatus(String status)` Sets task status

- Method Detail
  - getTaskID
```
String getTaskID()
```
    Returns the unique ID assigned to the task instance
  - getTaskURL
```
String getTaskURL()
```
    Returns url pointer to this task
  - getTaskTypeID
```
String getTaskTypeID()
```
    Returns the unique task type definition ID
  - getTaskViewPortletID
```
String getTaskViewPortletID()
```
    Returns ID of the task view portlet for this task
  - getTaskDetailsPageID
```
String getTaskDetailsPageID()
```
    Returns default task details page alias
  - getCreatedDate
```
Date getCreatedDate()
```
    Returns task created date
  - getCreatedBy
```
String getCreatedBy()
```
    Returns user ID (name) of the user who created the task
  - getLastModifiedDate
```
Date getLastModifiedDate()
```
    Returns task last modified date
  - getLastAcceptedDate
```
Date getLastAcceptedDate()
```
    Returns task last accepted date if any
  - getLastModifiedBy
```
String getLastModifiedBy()
```
    Returns user ID of the user who last modified the task
  - getLastAcceptedBy
```
String getLastAcceptedBy()
```
    Returns user ID (name) of the user who last accepted the task
  - getName
```
String getName()
```
    Returns task name
  - setName
```
void setName(String name)
             throws Exception
```
    Sets task name
    
    Parameters:
    name - the new task name
    
    Throws:
    
    Exception
  - getDescription
```
String getDescription()
```
    Returns task description
  - setDescription
```
void setDescription(String description)
                    throws Exception
```
    Sets task description
    
    Parameters:
    description - the new task description
    
    Throws:
    
    Exception
  - getStatus
```
String getStatus()
```
    Returns task status
  - setStatus
```
void setStatus(String status)
               throws Exception
```
    Sets task status
    
    Parameters:
    status - the new task status
    
    Throws:
    
    Exception
  - getPriority
```
String getPriority()
```
    Returns task priority
  - setPriority
```
void setPriority(String priority)
                 throws Exception
```
    Sets task priority
    
    Parameters:
    priority - the new task priority
    
    Throws:
    
    Exception
  - getExpireDate
```
Date getExpireDate()
```
    Returns expiration date for this task if any
  - setExpireDate
```
void setExpireDate(Date expireDate)
                   throws Exception
```
    Sets expire date for this task
    
    Parameters:
    expireDate - the new expiration date
    
    Throws:
    
    Exception
  - getAcceptedByList
```
String[] getAcceptedByList()
```
    Returns list of users who currently accepted the task
  - setAcceptedByList
```
void setAcceptedByList(String[] acceptedBy)
                       throws Exception
```
    Sets list of users who currently accepted the task
    
    Parameters:
    acceptedBy - new list of users who currently accepted the task
    
    Throws:
    
    Exception
  - getAssignedToList
```
String[] getAssignedToList()
```
    Returns list of principals (users, groups, roles) who this task is assigned to
  - getDelegatedToList
```
String[] getDelegatedToList()
```
    Returns list of principals (users, groups, roles) whom this task is delegated. The size of this list matches to size of ITaskInfo.getDelegatedFromList()
  - getDelegatedFromList
```
String[] getDelegatedFromList()
```
    Returns list of principals (users, groups, roles) who delegated this task. The size of this list matches to size of ITaskInfo.getDelegatedToList()
  - getDelegatedByList
```
String[] getDelegatedByList()
```
    Returns list of rule IDs which delegated the task. The size of the list matches to size of 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 ID
  - getDelegatedFrom
```
String getDelegatedFrom()
```
    Returns Determines and returns UID of the principal who has delegated current task to the current user. Returns null if task is not delegated to the current user
    
    Throws:
    
    Exception
  - getDelegationMap
```
Map getDelegationMap()
```
    Returns Returns a map of delegations for the current task. Both the key and value are user UIDs. The map is calulated from the lists returned by getDelegatedToList and getDelegatedFromList
  - setDelegationMap
```
void setDelegationMap(Map delegationMap)
                      throws Exception
```
    Returns Set the delegatedToList and delegatedFromList values from the contents of a Map. The input map is expected to entries where both the key and value are user UIDs.
    
    Throws:
    
    Exception
  - setAssignedToList
```
void setAssignedToList(String[] assignedTo)
                       throws Exception
```
    Sets list of principals who this task is assigned to
    
    Parameters:
    assignedTo - list of principals who this task is assigned to
    
    Throws:
    
    Exception
  - setDelegatedToList
```
void setDelegatedToList(String[] delegatedTo)
                        throws Exception
```
    Sets list of principals who this task is delegated
    
    Parameters:
    assignedTo - list of principals who this task is delegated
    
    Throws:
    
    Exception
  - setDelegatedFromList
```
void setDelegatedFromList(String[] delegatedFrom)
                          throws Exception
```
    Sets list of principals who this task is delegated
    
    Parameters:
    assignedTo - list of principals who this task is delegated
    
    Throws:
    
    Exception
  - getProcessInstanceID
```
String getProcessInstanceID()
```
    Returns Process instance ID which spawned this task
  - getProcessModelID
```
String getProcessModelID()
```
    Returns Process Model ID of owning process
  - getProcessModelVersion
```
String getProcessModelVersion()
```
    Returns Process Model Version of owning process
  - getProcessIteration
```
int getProcessIteration()
```
    Returns Process Iteration of owning process
  - getStepIteration
```
int getStepIteration()
```
    Returns Step iteration of owning process
  - getStepID
```
String getStepID()
```
    Returns Process stepID for this task
  - getCustomTaskID
```
String getCustomTaskID()
```
    Returns Task custom ID
  - setCustomTaskID
```
void setCustomTaskID(String customTaskID)
                     throws Exception
```
    Sets custom task ID
    
    Parameters:
    customTaskID - custom task ID
    
    Throws:
    
    Exception
  - getErrorMessage
```
String getErrorMessage()
```
    Returns Error message in the case of task be in the 'error' state
  - getErrorCode
```
String getErrorCode()
```
    Returns Error code in the case of task be in the 'error' state
  - setErrorMessage
```
void setErrorMessage(String errorMessage)
                     throws Exception
```
    Sets error message for this task
    
    Parameters:
    errorMessage - error message for this task
    
    Throws:
    
    Exception
  - setErrorCode
```
void setErrorCode(String errorCode)
                  throws Exception
```
    Sets error code for this task
    
    Parameters:
    errorCode - error code for this task
    
    Throws:
    
    Exception
  - isCurrentUserAccepted
```
boolean isCurrentUserAccepted()
                              throws Exception
```
    Returns true if current user accepted that task
    
    Throws:
    
    Exception
  - isForProcess
```
boolean isForProcess()
                     throws Exception
```
    Returns true if this task is part of collaboration process
    
    Throws:
    
    Exception
  - setForProcess
```
void setForProcess(boolean forProcess)
                   throws Exception
```
    Marks this task to participate in collaboration process
    
    Parameters:
    forProcess - should be true if this task needs to be marked to participate in collaboration process
    
    Throws:
    
    Exception
  - getParentTaskID
```
String getParentTaskID()
```
    Returns reference task ID for parent task.
  - setParentTaskID
```
void setParentTaskID(String parentTaskID)
                     throws Exception
```
    Sets reference task ID for parent task.
    
    Parameters:
    parentTaskID - reference task ID for parent task
    
    Throws:
    
    Exception
  - getCollaborationProcessID
```
String getCollaborationProcessID()
```
    Returns ID of ad-hoc workflow process for this task
  - setCollaborationProcessID
```
void setCollaborationProcessID(String collaborationProcessID)
                               throws Exception
```
    Sets ID of ad-hoc workflow process for this task
    
    Parameters:
    collaborationProcessID - ID of collaboration process for this task
    
    Throws:
    
    Exception
  - getCollaborationStepID
```
String getCollaborationStepID()
```
    Returns ID of ad-hoc workflow process step for this task
  - setCollaborationStepID
```
void setCollaborationStepID(String collaborationStepID)
                            throws Exception
```
    Sets ID of ad-hoc workflow process step for this task
    
    Parameters:
    collaborationStepID - ID of collaboration process for this task
    
    Throws:
    
    Exception
  - getReferenceTaskIDForUser
```
String getReferenceTaskIDForUser(String user)
```
    Returns reference taskID specific for a given user (like when task was added to the user through some other task). Returns null if does not have a reference
    
    Parameters:
    user - given user

Interface ITaskInfo

Field Summary

Fields inherited from interface com.webmethods.caf.faces.data.task.ITaskConstants

Method Summary

Method Detail

getTaskID

getTaskURL

getTaskTypeID

getTaskViewPortletID

getTaskDetailsPageID

getCreatedDate

getCreatedBy

getLastModifiedDate

getLastAcceptedDate

getLastModifiedBy

getLastAcceptedBy

getName

setName

getDescription

setDescription

getStatus

setStatus

getPriority

setPriority

getExpireDate

setExpireDate

getAcceptedByList

setAcceptedByList

getAssignedToList

getDelegatedToList

getDelegatedFromList

getDelegatedByList

getDelegatedFrom

getDelegationMap

setDelegationMap

setAssignedToList

setDelegatedToList

setDelegatedFromList

getProcessInstanceID

getProcessModelID

getProcessModelVersion

getProcessIteration

getStepIteration

getStepID

getCustomTaskID

setCustomTaskID

getErrorMessage

getErrorCode

setErrorMessage

setErrorCode

isCurrentUserAccepted

isForProcess

setForProcess

getParentTaskID

setParentTaskID

getCollaborationProcessID

setCollaborationProcessID

getCollaborationStepID

setCollaborationStepID

getReferenceTaskIDForUser