Package fr.gouv.vitam.common.model.processing

# Enum Class PauseOrCancelAction

java.lang.Object
java.lang.Enum<PauseOrCancelAction>
fr.gouv.vitam.common.model.processing.PauseOrCancelAction

All Implemented Interfaces:
  `Serializable`, `Comparable<PauseOrCancelAction>`, `Constable`

public enum PauseOrCancelAction extends Enum<PauseOrCancelAction>

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant
  Description
  `ACTION_CANCEL`
  When the cancel occurs, the current step will be marked as ACTION_CANCEL
  `ACTION_COMPLETE`
  When the step is finished without pause nor cancel, the current step will be marked as ACTION_COMPLETE
  `ACTION_PAUSE`
  When the pause occurs, the current step will be marked as ACTION_PAUSE
  `ACTION_RECOVER`
  When the step was ACTION_PAUSE, after restart the step will be marked as ACTION_RECOVER
  `ACTION_REPLAY`
  When the replay occurs, the current step will be marked as ACTION_REPLAY, so it could be replayed
  `ACTION_RUN`
  The default PauseOrCancelAction

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static PauseOrCancelAction`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static PauseOrCancelAction[]`
  `values()`
  Returns an array containing the constants of this enum class, in the order they are declared.

  ### Methods inherited from class java.lang.Enum

  `clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

  ### Methods inherited from class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Enum Constant Details

  - ### ACTION_RUN

    public static final PauseOrCancelAction ACTION_RUN
    The default PauseOrCancelAction

  - ### ACTION_RECOVER

    public static final PauseOrCancelAction ACTION_RECOVER
    When the step was ACTION_PAUSE, after restart the step will be marked as ACTION_RECOVER

  - ### ACTION_REPLAY

    public static final PauseOrCancelAction ACTION_REPLAY
    When the replay occurs, the current step will be marked as ACTION_REPLAY, so it could be replayed

  - ### ACTION_PAUSE

    public static final PauseOrCancelAction ACTION_PAUSE
    When the pause occurs, the current step will be marked as ACTION_PAUSE

  - ### ACTION_CANCEL

    public static final PauseOrCancelAction ACTION_CANCEL
    When the cancel occurs, the current step will be marked as ACTION_CANCEL

  - ### ACTION_COMPLETE

    public static final PauseOrCancelAction ACTION_COMPLETE
    When the step is finished without pause nor cancel, the current step will be marked as ACTION_COMPLETE

- ## Method Details

  - ### values

    public static PauseOrCancelAction[] 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 PauseOrCancelAction 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