Package com.axemble.vdoc.sdk.interfaces

Interface ITask

All Superinterfaces:
IConnectorParentContextSupport, IDelegationSupport, IElement, ILocalizationScope, IProtocolSupport, ISearchSupport, Serializable
All Known Subinterfaces:
IActionTask, IApplicationTask, IDecisionTask, IManualTask
public interface ITask extends IElement, ISearchSupport, IDelegationSupport, ILocalizationScope, IConnectorParentContextSupport
This class represents the definition of a class.
Since:
v1.0
Version:
1.0, 15/04/2008
Author:
vlygeros
See Also:

  • Method Details

    • getName

      String getName()
      Gets the system name of the task.
      Returns:
      A java.lang.String value.

    • getLabel

      String getLabel()
      Gets the label of the task.
      Returns:
      A java.lang.String value.

    • getLabel

      String getLabel(String language)
      Gets the label of the task.
      Returns:
      A java.lang.String value.

    • getDescription

      String getDescription()
      Returns:
      The description of the task

    • getSendWarningFrequency

      String getSendWarningFrequency()
      Gets the frequency to send a warning email
      Returns:
      The frequency.

    • setSendWarningFrequency

      void setSendWarningFrequency(String frequency)
      Sets the frequency to send a warning email
      Parameters:
      frequency - The frequency (DAY, MONDAY, TUESDAY, ...).

    • getDelay

      long getDelay()
      Gets the available delay to execute the task.
      Returns:
      The delay in seconds.

    • setDelay

      void setDelay(long delay)
      Sets the delay of the task.
      Parameters:
      delay - The delay in seconds.

    • getDelayAction

      IAction getDelayAction()
      Retrieves the IAction to execute if late.
      Returns:
      A IAction object.

    • getAction

      IAction getAction(String name)
      Retrieves an action by its name.
      Parameters:
      name - The system name of the action.
      Returns:
      A IAction object.

    • getActions

      Collection<? extends IAction> getActions()
      Retrieves a the actions of a task.
      Returns:
      A collection of IAction objects.

    • getWorkflow

      IWorkflow getWorkflow()
      Retrieves the workflow of the task.
      Returns:
      A IWorkflow object.

    • getRole

      @Deprecated IRole getRole()
      Deprecated.
      use getOperatorRole() method instead.
      Gets the associated IOperatorRole if the task is manual.
      Returns:
      A IRole object.

    • getOperatorRole

      IOperatorRole getOperatorRole()
      Gets the associated IOperatorRole if the task is manual.
      Returns:
      A IOperatorRole object.

    • getForm

      IForm getForm()
      Gets the IForm associated with the task.
      Returns:
      A IForm object.

    • getMailForm

      IMailForm getMailForm(int type)
      Gets the IMailForm associated with the task.
      Parameters:
      type - The type of the mail form.
      Returns:
      A IMailForm object.

    • isAbortAllowed

      boolean isAbortAllowed()
      Checks if the current task allows abort operation.
      Returns:
      true if the task allows abort operation, false otherwise.

    • isReminderAllowed

      boolean isReminderAllowed()
      Checks if the current task allows remind operation.
      Returns:
      true if the task allows remind operation, false otherwise.

    • isDelegationAllowed

      boolean isDelegationAllowed()
      Checks if the current task allows delegation operation.
      Returns:
      true if the task allows delegation operation, false otherwise.