Package com.aquima.interactions.process

Interface IProcessTaskView

All Known Implementing Classes:
ProcessTaskView
public interface IProcessTaskView
This interface defines a readonly view of a process task
Since:
9.1
Author:
N. van Noorloos

  • Method Details

    • getId

      long getId()
      This method returns the unique ID of this task.
      Returns:
      the unique ID of this process step.

    • getNodeId

      GUID getNodeId()
      This method returns the optional node ID this task belongs to.
      Returns:
      the node ID of this task.

    • getPriority

      Integer getPriority()
      This method returns the priority of this task.
      Returns:
      the priority of this task.

    • getCaseId

      long getCaseId()
      This method returns the ID of the case the task is defined for.
      Returns:
      The ID of the case the task is defined for.

    • isCaseLocked

      boolean isCaseLocked()
      This method returns if the case the task is defined for is locked.
      Returns:
      a boolean indicating if the case the task is defined for is locked

    • getAssigneeInfo

      IAssigneeInfo getAssigneeInfo()
      This method returns the AssigneeInfo of whom the task is assigned to.
      Returns:
      the AssigneeInfo of whom the task is assigned to.

    • getName

      String getName()
      This method returns the name of the task as present in the task definition.
      Returns:
      The name of the task.

    • getDescription

      String getDescription()
      This method returns the description of the task as present in the task definition.
      Returns:
      The description of the task.

    • getDisplayName

      IMultilingualText getDisplayName()
      This method returns the display name of the task as present in the task definition.
      Returns:
      The display name of the task.

    • getRequiredRoles

      IRole[] getRequiredRoles()
      This method returns the names of required roles to start this task.
      Returns:
      The names of the required roles.

    • getRequiredRoutingAlgorithm

      IRoutingAlgorithmDefinition getRequiredRoutingAlgorithm()
      This method returns the names of required routing algorithms to start this task.
      Returns:
      The names of the required routing algorithms.

    • getStatus

      TaskStatusType getStatus()
      This method returns the current status of the task.
      Returns:
      the current status of the task.

    • getStartDate

      DateTimeValue getStartDate()
      This method returns the date at which the task may start.
      Returns:
      The date at which the task may start.

    • getTimeoutDate

      DateTimeValue getTimeoutDate()
      this method returns the date at which the task will expire
      Returns:
      The date at which the task will expire

    • getDueDate

      DateTimeValue getDueDate()
      this method returns the date at which the task should be completed.
      Returns:
      The date at which the task should be completed.

    • getAttributeValue

      IValue getAttributeValue(String entityName, String attributeName)
      this method returns the value of the attribute from the case the task is defined for.
      Parameters:
      entityName - The entity where the attribute belongs to.
      attributeName - The name of the attribute.
      Returns:
      The value of the attribute from the case the task is defined for.

    • getAttributes

      AttributeReference[] getAttributes()
      this method returns the attributes from the case for which a value is set
      Returns:
      the attributes from the case for which a value is set

    • getCustomFieldValue

      IValue getCustomFieldValue(String customField)
      this method returns the value of a custom field for the task.
      Parameters:
      customField - The custom field.
      Returns:
      The value of the custom field from the task.

    • getCustomFields

      String[] getCustomFields()
      this method returns the custom fields defined for the task
      Returns:
      the custom fields defined for the task

    • isRequired

      boolean isRequired()