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

Interface ITaskInfo

All Superinterfaces:
ITaskConstants, ITaskConstants
All Known Implementing Classes:
TaskInfo
public interface ITaskInfo extends ITaskConstants
ITaskInfo is the interface representing Task Information.

  • Method Details

    • 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

    • setCreatedDate

      void setCreatedDate(Date createdDate) throws Exception
      Sets created date for this task
      Parameters:
      createdDate - the new created date
      Throws:
      Exception

    • 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 getDelegatedFromList()

    • getDelegatedFromList

      String[] getDelegatedFromList()
      Returns list of principals (users, groups, roles) who delegated this task. The size of this list matches to size of getDelegatedToList()

    • getDelegatedByList

      String[] getDelegatedByList()
      Returns list of rule IDs which delegated the task. The size of the list matches to size of getDelegatedToList() and 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<String,String> 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<String,String> 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

    • getRootProcessInstanceID

      String getRootProcessInstanceID()
      Root process instance ID whose sub process 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

    • getIsMandatory

      Integer getIsMandatory()
      Returns If the child task is mandatory or not

    • setIsMandatory

      void setIsMandatory(Integer isMandatory)
      Sets If the child task is mandatory or not
      Parameters:
      isMandatory -
      Throws:
      Exception

    • getTaskScheduleDate

      Date getTaskScheduleDate()
      Returns task schedule start date

    • setTaskScheduleDate

      void setTaskScheduleDate(Date taskScheduleDate)
      sets the task schedule start date
      Parameters:
      taskScheduleDate -
      Throws:
      Exception

    • getIsVotable

      Integer getIsVotable()
      Returns if the task is votable or not

    • setIsVotable

      void setIsVotable(Integer isVotable)
      Sets if the task is votable or not
      Parameters:
      isVotable -

    • getTaskVotingTable

      String getTaskVotingTable()
      Returns the voting table for the task which contains the voting strategy and its configuration

    • setTaskVotingTable

      void setTaskVotingTable(String table)
      Sets the voting table definition for the task
      Parameters:
      table -