Package com.veeva.vault.sdk.api.workflow

Enum Class WorkflowEvent

java.lang.Object
java.lang.Enum<WorkflowEvent>
com.veeva.vault.sdk.api.workflow.WorkflowEvent
All Implemented Interfaces:
Serializable, Comparable<WorkflowEvent>, Constable
public enum WorkflowEvent extends Enum<WorkflowEvent>
Events surrounding workflow execution. Each workflow event is tied to a specific workflow step type, and can only execute during a step of that type.

  • Enum Constant Details

    • DISPLAY_PARTICIPANTS

      public static final WorkflowEvent DISPLAY_PARTICIPANTS
      Occurs when displaying participants in the workflow start step. At this point, the workflow instance has not been created.

    • GET_PARTICIPANTS

      public static final WorkflowEvent GET_PARTICIPANTS
      Occurs when saving the provided participants to the participant group, which occurs immediately after the start step dialog is submitted. At this point, the workflow instance has not been created.

    • AFTER_CREATE

      public static final WorkflowEvent AFTER_CREATE
      Occurs immediately after the workflow instance is created, which is directly after the GET_PARTICIPANTS event. This executes before any steps which follow the start step.

    • TASK_AFTER_CREATE

      public static final WorkflowEvent TASK_AFTER_CREATE
      Occurs immediately after task creation. If task creation includes initial assignment to a participant group, occurs after the initial assignment. Note that the event context may contain multiple task instances.

    • TASK_AFTER_CANCEL

      public static final WorkflowEvent TASK_AFTER_CANCEL
      Occurs immediately after cancellation of a task instance. Task cancellation can happen in the following instances:
      • User manually cancels a task
      • User completes a task, which triggers the workflow to short-circuit and cancel other task instances
      • User manually cancels an entire workflow
      If multiple task instances are cancelled at the same time, the TASK_AFTER_CANCEL event fires once for each task step. For example, a user completes a task which short-circuits the workflow and cancels all the tasks in two remaining task steps. If these task steps had custom actions configured on the TASK_AFTER_CANCEL event, the action logic only executes two times even if there are multiple task instances in each remaining task step.

    • TASK_BEFORE_COMPLETE_DIALOG

      public static final WorkflowEvent TASK_BEFORE_COMPLETE_DIALOG
      Occurs immediately before displaying the completion dialog of a task instance.

    • TASK_AFTER_COMPLETE

      public static final WorkflowEvent TASK_AFTER_COMPLETE
      Occurs immediately after completion of a task instance.

    • TASK_AFTER_ASSIGN

      public static final WorkflowEvent TASK_AFTER_ASSIGN
      Occurs immediately after acceptance or reassignment of a task instance. This does not include initial assignment during task instance creation.

  • Method Details

    • values

      public static WorkflowEvent[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static WorkflowEvent valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getStepType

      public WorkflowStepType getStepType()
      Indicates the associated WorkflowStepType for this workflow event. This is the step type each event is tied to.
      Returns:
      the associated workflow step type