Package com.webmethods.caf.faces.data.task.impl

Class TaskInfo

java.lang.Object
com.webmethods.caf.faces.data.task.impl.TaskInfo
All Implemented Interfaces:
ITaskConstants, ITaskExtendedInfo, ITaskInfo, ITaskConstants
public class TaskInfo extends Object implements ITaskInfo, ITaskExtendedInfo
TaskInfo is the concrete implementation of ITaskInfo and ITaskExtendedInfo

  • Constructor Details

    • TaskInfo

      public TaskInfo()

  • Method Details

    • getTaskScheduleDate

      public Date getTaskScheduleDate()
      Description copied from interface: ITaskInfo
      Returns task schedule start date
      Specified by:
      getTaskScheduleDate in interface ITaskInfo

    • setTaskScheduleDate

      public void setTaskScheduleDate(Date taskScheduleDate)
      Description copied from interface: ITaskInfo
      sets the task schedule start date
      Specified by:
      setTaskScheduleDate in interface ITaskInfo

    • getIsMandatory

      public Integer getIsMandatory()
      Description copied from interface: ITaskInfo
      Returns If the child task is mandatory or not
      Specified by:
      getIsMandatory in interface ITaskInfo

    • setIsMandatory

      public void setIsMandatory(Integer isMandatory)
      Description copied from interface: ITaskInfo
      Sets If the child task is mandatory or not
      Specified by:
      setIsMandatory in interface ITaskInfo

    • 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

    • getRunning

      public boolean getRunning()

    • 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

    • setRunning

      public void setRunning(boolean running)

    • 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

    • setCreatedDate

      public void setCreatedDate(Date createdDate) throws Exception
      Description copied from interface: ITaskInfo
      Sets created date for this task
      Specified by:
      setCreatedDate in interface ITaskInfo
      Parameters:
      createdDate - the new created 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<String,String> 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<String,String> 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<String,Object> 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

    • getIsVotable

      public Integer getIsVotable()
      Description copied from interface: ITaskInfo
      Returns if the task is votable or not
      Specified by:
      getIsVotable in interface ITaskInfo

    • setIsVotable

      public void setIsVotable(Integer isVotable)
      Description copied from interface: ITaskInfo
      Sets if the task is votable or not
      Specified by:
      setIsVotable in interface ITaskInfo

    • getTaskVotingTable

      public String getTaskVotingTable()
      Description copied from interface: ITaskInfo
      Returns the voting table for the task which contains the voting strategy and its configuration
      Specified by:
      getTaskVotingTable in interface ITaskInfo

    • setTaskVotingTable

      public void setTaskVotingTable(String taskVotingTable)
      Description copied from interface: ITaskInfo
      Sets the voting table definition for the task
      Specified by:
      setTaskVotingTable in interface ITaskInfo

    • getRootProcessInstanceID

      public String getRootProcessInstanceID()
      Description copied from interface: ITaskInfo
      Root process instance ID whose sub process spawned this task
      Specified by:
      getRootProcessInstanceID in interface ITaskInfo