Package com.aquima.interactions.process

Interface IProcessTaskDefinition

All Known Implementing Classes:
ProcessTaskDefinition
public interface IProcessTaskDefinition
This interface defines a single task that may be scheduled by the process engine.
Since:
7.1
Author:
O. Kerpershoek

  • Method Details

    • getId

      GUID getId()
      This method returns the unique identifier of the task definition.
      Returns:
      the unique identifier of the task definition.

    • getName

      String getName()
      This method returns the (unique) name of the task definition.
      Returns:
      the (unique) name of the task definition.

    • getDescription

      String getDescription()
      This method returns a description of the process task definition.
      Returns:
      a description of the process task definition.

    • getDisplayName

      IMultilingualText getDisplayName()
      This method returns a text object containing the name that should be used for display purposes. May be null.
      Returns:
      a text object containing the name that should be used for display purposes.

    • getRoles

      IRole[] getRoles()
      This method returns an array containing the roles that allow a user to execute the task. If the method returns an empty array, than the task may be execute by anyone, regardless of role. A user wishing to execute the task should have at least one of the required roles.
      Returns:
      array containing the roles that allow a user to execute the task.

    • getAuthorizationAlgorithm

      IAuthorizationAlgorithmDefinition getAuthorizationAlgorithm()
      This method returns the authorization algorithm. If none provided everyone may execute the task.
      Returns:
      The authorization algorithm, or null.

    • getPriorityAlgorithm

      IPriorityAlgorithmDefinition getPriorityAlgorithm()
      This method returns the priority algorithm.
      Returns:
      The priority algorithm, or null.

    • getRoutingAlgorithm

      IRoutingAlgorithmDefinition getRoutingAlgorithm()
      This method returns the routing algorithm. If the method returns an empty array, than the task may be execute by anyone, regardless of routing algorithm.
      Returns:
      The routing algorithm

    • getExitStates

      TaskExit[] getExitStates()
      This method returns an array containing the possible exit states of the task. This array should always consist of at least two values, a continue exit and an abort exit. If more than one continue or cancel exit is present, then each exit must have a unique name.
      Returns:
      Array containing the possible exit states of the task.

    • isAutomatic

      boolean isAutomatic()
      This method returns a boolean indicating if the task is an automated task, and thus should be handled by the system in stead of a user.
      Returns:
      a boolean indicating if the task is an automated task.

    • getRetryCountExpression

      IExpression getRetryCountExpression()
      This method returns the expression that should be evaluated for automatic tasks to determine the number of times the task should be retried in case of failure. When the method does not return a (valid) expression, the task will be executed once.
      Returns:
      Expression to determine the retry count for a failed automatic task.

    • getRetryInterval

      long getRetryInterval()
      This method returns the interval in minutes the automatic task should wait before a failed task should be attempted again.
      Returns:
      The interval in minutes between execution attempts of the automatic task.

    • getDueDate

      IExpression getDueDate()
      Gets the expression that determines the date on which this task should be ended.
      Returns:
      Expression resulting in a date.

    • getReevaluationEvent

      ReevaluationEvent getReevaluationEvent()
      This method returns the reevaluation event
      Returns:
      The reevaluation event

    • getCustomFields

      IProcessTaskCustomField[] getCustomFields()
      Gets the custom fields which are stored on this task.
      Returns:
      Array of custom fields.