com.webmethods.caf.faces.data.task.impl
Class TaskInfo

java.lang.Object
  extended by com.webmethods.caf.faces.data.task.impl.TaskInfo
All Implemented Interfaces:
ITaskConstants, ITaskExtendedInfo, ITaskInfo

public class TaskInfo
extends Object
implements ITaskInfo, ITaskExtendedInfo

TaskInfo is the concrete implementation of ITaskInfo and ITaskExtendedInfo


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_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
 
Constructor Summary
TaskInfo()
           
 
Method Summary
 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 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 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
 int getTaskVersionNumber()
          Returns task version number.
 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 stepID)
          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[] assignedTo)
          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 referenceTaskID)
          Sets reference task ID for parent task.
 void setPriority(String priority)
          Sets task priority
 void setStatus(String status)
          Sets task status
 void setTaskVersionNumber(int versionNumber)
          Set task version number
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TaskInfo

public TaskInfo()
Method Detail

getTaskID

public String getTaskID()
Description copied from interface: ITaskInfo
Returns the unique ID assigned to the task instance

Specified by:
getTaskID in interface ITaskInfo

getTaskURL

public String getTaskURL()
Description copied from interface: ITaskInfo
Returns url pointer to this task

Specified by:
getTaskURL in interface ITaskInfo

getTaskViewPortletID

public String getTaskViewPortletID()
Description copied from interface: ITaskInfo
Returns ID of the task view portlet for this task

Specified by:
getTaskViewPortletID in interface ITaskInfo

getTaskTypeID

public String getTaskTypeID()
Description copied from interface: ITaskInfo
Returns the unique task type definition ID

Specified by:
getTaskTypeID in interface ITaskInfo

getAcceptedByList

public String[] getAcceptedByList()
Description copied from interface: ITaskInfo
Returns list of users who currently accepted the task

Specified by:
getAcceptedByList in interface ITaskInfo

getAssignedToList

public String[] getAssignedToList()
Description copied from interface: ITaskInfo
Returns list of principals (users, groups, roles) who this task is assigned to

Specified by:
getAssignedToList in interface ITaskInfo

getCreatedBy

public String getCreatedBy()
Description copied from interface: ITaskInfo
Returns user ID (name) of the user who created the task

Specified by:
getCreatedBy in interface ITaskInfo

getCreatedDate

public Date getCreatedDate()
Description copied from interface: ITaskInfo
Returns task created date

Specified by:
getCreatedDate in interface ITaskInfo

getDescription

public String getDescription()
Description copied from interface: ITaskInfo
Returns task description

Specified by:
getDescription in interface ITaskInfo

getLastAcceptedBy

public String getLastAcceptedBy()
Description copied from interface: ITaskInfo
Returns user ID (name) of the user who last accepted the task

Specified by:
getLastAcceptedBy in interface ITaskInfo

getLastModifiedBy

public String getLastModifiedBy()
Description copied from interface: ITaskInfo
Returns user ID of the user who last modified the task

Specified by:
getLastModifiedBy in interface ITaskInfo

getLastModifiedDate

public Date getLastModifiedDate()
Description copied from interface: ITaskInfo
Returns task last modified date

Specified by:
getLastModifiedDate in interface ITaskInfo

getLastAcceptedDate

public Date getLastAcceptedDate()
Description copied from interface: ITaskInfo
Returns task last accepted date if any

Specified by:
getLastAcceptedDate in interface ITaskInfo

getName

public String getName()
Description copied from interface: ITaskInfo
Returns task name

Specified by:
getName in interface ITaskInfo

getPriority

public String getPriority()
Description copied from interface: ITaskInfo
Returns task priority

Specified by:
getPriority in interface ITaskInfo

getStatus

public String getStatus()
Description copied from interface: ITaskInfo
Returns task status

Specified by:
getStatus in interface ITaskInfo

setDescription

public void setDescription(String description)
Description copied from interface: ITaskInfo
Sets task description

Specified by:
setDescription in interface ITaskInfo
Parameters:
description - the new task description

setName

public void setName(String name)
Description copied from interface: ITaskInfo
Sets task name

Specified by:
setName in interface ITaskInfo
Parameters:
name - the new task name

setPriority

public void setPriority(String priority)
Description copied from interface: ITaskInfo
Sets task priority

Specified by:
setPriority in interface ITaskInfo
Parameters:
priority - the new task priority

setStatus

public void setStatus(String status)
Description copied from interface: ITaskInfo
Sets task status

Specified by:
setStatus in interface ITaskInfo
Parameters:
status - the new task status

getExpireDate

public Date getExpireDate()
Description copied from interface: ITaskInfo
Returns expiration date for this task if any

Specified by:
getExpireDate in interface ITaskInfo

setExpireDate

public void setExpireDate(Date expireDate)
                   throws Exception
Description copied from interface: ITaskInfo
Sets expire date for this task

Specified by:
setExpireDate in interface ITaskInfo
Parameters:
expireDate - the new expiration date
Throws:
Exception

getCustomTaskID

public String getCustomTaskID()
Description copied from interface: ITaskInfo
Returns Task custom ID

Specified by:
getCustomTaskID in interface ITaskInfo

setCustomTaskID

public void setCustomTaskID(String customTaskID)
Description copied from interface: ITaskInfo
Sets custom task ID

Specified by:
setCustomTaskID in interface ITaskInfo
Parameters:
customTaskID - custom task ID

getProcessInstanceID

public String getProcessInstanceID()
Description copied from interface: ITaskInfo
Returns Process instance ID which spawned this task

Specified by:
getProcessInstanceID in interface ITaskInfo

getStepID

public String getStepID()
Description copied from interface: ITaskInfo
Returns Process stepID for this task

Specified by:
getStepID in interface ITaskInfo

getProcessIteration

public int getProcessIteration()
Description copied from interface: ITaskInfo
Returns Process Iteration of owning process

Specified by:
getProcessIteration in interface ITaskInfo

getProcessModelID

public String getProcessModelID()
Description copied from interface: ITaskInfo
Returns Process Model ID of owning process

Specified by:
getProcessModelID in interface ITaskInfo

getProcessModelVersion

public String getProcessModelVersion()
Description copied from interface: ITaskInfo
Returns Process Model Version of owning process

Specified by:
getProcessModelVersion in interface ITaskInfo

getStepIteration

public int getStepIteration()
Description copied from interface: ITaskInfo
Returns Step iteration of owning process

Specified by:
getStepIteration in interface ITaskInfo

setAcceptedByList

public void setAcceptedByList(String[] acceptedBy)
                       throws Exception
Description copied from interface: ITaskInfo
Sets list of users who currently accepted the task

Specified by:
setAcceptedByList in interface ITaskInfo
Parameters:
acceptedBy - new list of users who currently accepted the task
Throws:
Exception

setAssignedToList

public void setAssignedToList(String[] assignedTo)
                       throws Exception
Description copied from interface: ITaskInfo
Sets list of principals who this task is assigned to

Specified by:
setAssignedToList in interface ITaskInfo
Parameters:
assignedTo - list of principals who this task is assigned to
Throws:
Exception

getDelegatedToList

public String[] getDelegatedToList()
Description copied from interface: ITaskInfo
Returns list of principals (users, groups, roles) whom this task is delegated. The size of this list matches to size of ITaskInfo.getDelegatedFromList()

Specified by:
getDelegatedToList in interface ITaskInfo

setDelegatedToList

public void setDelegatedToList(String[] assignedTo)
                        throws Exception
Description copied from interface: ITaskInfo
Sets list of principals who this task is delegated

Specified by:
setDelegatedToList in interface ITaskInfo
Throws:
Exception

getDelegatedByList

public String[] getDelegatedByList()
Description copied from interface: ITaskInfo
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

Specified by:
getDelegatedByList in interface ITaskInfo

getDelegatedFromList

public String[] getDelegatedFromList()
Description copied from interface: ITaskInfo
Returns list of principals (users, groups, roles) who delegated this task. The size of this list matches to size of ITaskInfo.getDelegatedToList()

Specified by:
getDelegatedFromList in interface ITaskInfo

getDelegatedFrom

public String getDelegatedFrom()
                        throws ContentProviderException
Description copied from interface: ITaskInfo
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

Specified by:
getDelegatedFrom in interface ITaskInfo
Throws:
ContentProviderException

setDelegatedFromList

public void setDelegatedFromList(String[] delegatedFrom)
                          throws Exception
Description copied from interface: ITaskInfo
Sets list of principals who this task is delegated

Specified by:
setDelegatedFromList in interface ITaskInfo
Throws:
Exception

getDelegationMap

public Map getDelegationMap()
Description copied from interface: ITaskInfo
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

Specified by:
getDelegationMap in interface ITaskInfo

setDelegationMap

public void setDelegationMap(Map delegationMap)
                      throws Exception
Description copied from interface: ITaskInfo
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.

Specified by:
setDelegationMap in interface ITaskInfo
Throws:
Exception

getChangedProperties

public Map getChangedProperties()
Description copied from interface: ITaskExtendedInfo
Returns map of changed properties with the task field name defined in ITaskConstants as the key and changed value as the value

Specified by:
getChangedProperties in interface ITaskExtendedInfo

getTaskVersionNumber

public int getTaskVersionNumber()
                         throws Exception
Description copied from interface: ITaskExtendedInfo
Returns task version number. Task version number is incremented for each task update

Specified by:
getTaskVersionNumber in interface ITaskExtendedInfo
Throws:
Exception

setTaskVersionNumber

public void setTaskVersionNumber(int versionNumber)
                          throws Exception
Description copied from interface: ITaskExtendedInfo
Set task version number

Specified by:
setTaskVersionNumber in interface ITaskExtendedInfo
Parameters:
versionNumber - task version number
Throws:
Exception

getErrorCode

public String getErrorCode()
Description copied from interface: ITaskInfo
Returns Error code in the case of task be in the 'error' state

Specified by:
getErrorCode in interface ITaskInfo

getErrorMessage

public String getErrorMessage()
Description copied from interface: ITaskInfo
Returns Error message in the case of task be in the 'error' state

Specified by:
getErrorMessage in interface ITaskInfo

setErrorCode

public void setErrorCode(String errorCode)
                  throws Exception
Description copied from interface: ITaskInfo
Sets error code for this task

Specified by:
setErrorCode in interface ITaskInfo
Parameters:
errorCode - error code for this task
Throws:
Exception

setErrorMessage

public void setErrorMessage(String errorMessage)
                     throws Exception
Description copied from interface: ITaskInfo
Sets error message for this task

Specified by:
setErrorMessage in interface ITaskInfo
Parameters:
errorMessage - error message for this task
Throws:
Exception

isCurrentUserAccepted

public boolean isCurrentUserAccepted()
                              throws Exception
Description copied from interface: ITaskInfo
Returns true if current user accepted that task

Specified by:
isCurrentUserAccepted in interface ITaskInfo
Throws:
Exception

getDelegatedBy

public String getDelegatedBy()
                      throws Exception
Throws:
Exception

getTaskDetailsPageID

public String getTaskDetailsPageID()
Description copied from interface: ITaskInfo
Returns default task details page alias

Specified by:
getTaskDetailsPageID in interface ITaskInfo

getCollaborationProcessID

public String getCollaborationProcessID()
Description copied from interface: ITaskInfo
Returns ID of ad-hoc workflow process for this task

Specified by:
getCollaborationProcessID in interface ITaskInfo

getParentTaskID

public String getParentTaskID()
Description copied from interface: ITaskInfo
Returns reference task ID for parent task.

Specified by:
getParentTaskID in interface ITaskInfo

isForProcess

public boolean isForProcess()
                     throws Exception
Description copied from interface: ITaskInfo
Returns true if this task is part of collaboration process

Specified by:
isForProcess in interface ITaskInfo
Throws:
Exception

setCollaborationProcessID

public void setCollaborationProcessID(String collaborationProcessID)
                               throws Exception
Description copied from interface: ITaskInfo
Sets ID of ad-hoc workflow process for this task

Specified by:
setCollaborationProcessID in interface ITaskInfo
Parameters:
collaborationProcessID - ID of collaboration process for this task
Throws:
Exception

getCollaborationStepID

public String getCollaborationStepID()
Description copied from interface: ITaskInfo
Returns ID of ad-hoc workflow process step for this task

Specified by:
getCollaborationStepID in interface ITaskInfo

setCollaborationStepID

public void setCollaborationStepID(String stepID)
Description copied from interface: ITaskInfo
Sets ID of ad-hoc workflow process step for this task

Specified by:
setCollaborationStepID in interface ITaskInfo
Parameters:
stepID - ID of collaboration process for this task

setForProcess

public void setForProcess(boolean forProcess)
                   throws Exception
Description copied from interface: ITaskInfo
Marks this task to participate in collaboration process

Specified by:
setForProcess in interface ITaskInfo
Parameters:
forProcess - should be true if this task needs to be marked to participate in collaboration process
Throws:
Exception

setParentTaskID

public void setParentTaskID(String referenceTaskID)
                     throws Exception
Description copied from interface: ITaskInfo
Sets reference task ID for parent task.

Specified by:
setParentTaskID in interface ITaskInfo
Parameters:
referenceTaskID - reference task ID for parent task
Throws:
Exception

getReferenceTaskIDForUser

public String getReferenceTaskIDForUser(String user)
Description copied from interface: ITaskInfo
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

Specified by:
getReferenceTaskIDForUser in interface ITaskInfo
Parameters:
user - given user