Package de.dlr.proseo.model.enums

Enum Class OrderState

java.lang.Object
java.lang.Enum<OrderState>
de.dlr.proseo.model.enums.OrderState
All Implemented Interfaces:
Serializable, Comparable<OrderState>, Constable
public enum OrderState extends Enum<OrderState>
Possible states for a processing order; legal state transitions:
  1. INITIAL -> APPROVED: Customer approved order parameters and/or committed budget
  2. APPROVED -> PLANNED: Jobs for the processing order have been generated
  3. PLANNED -> RELEASED: The order is released for running as planned
  4. RELEASED -> RUNNING: The first jobs have started, further jobs can be started
  5. RUNNING -> SUSPENDING: Order execution halted, no further jobs will be started (started jobs will be completed, if they are not halted themselves)
  6. SUSPENDING -> PLANNED: All jobs for the order are either completed or halted (after suspending the order)
  7. RUNNING -> COMPLETED: All jobs have been completed successfully
  8. RUNNING -> FAILED: All jobs have been completed, but at least one of them failed
  9. PLANNED -> FAILED: The order was cancelled by the operator
  10. COMPLETED/FAILED ->; CLOSED: Delivery/failure has been acknowledged by customer and/or order fee has been paid
Author:
Dr. Thomas Bassler

  • Enum Constant Details

    • INITIAL

      public static final OrderState INITIAL
      Order has been created and can be modified through REST API, GUI or CLI

    • APPROVED

      public static final OrderState APPROVED
      Order has been approved (e. g. order parameters, bulk processing budget etc.)

    • PLANNING

      public static final OrderState PLANNING
      Planning process is running

    • PLANNING_FAILED

      public static final OrderState PLANNING_FAILED
      Planning process has failed

    • PLANNED

      public static final OrderState PLANNED
      Planning process completed, or retry has been issued

    • RELEASING

      public static final OrderState RELEASING
      Releasing process is running

    • RELEASED

      public static final OrderState RELEASED
      Releasing process completed, but no job has yet been started

    • RUNNING

      public static final OrderState RUNNING
      Releasing process completed and at least one job is running

    • SUSPENDING

      public static final OrderState SUSPENDING
      A suspend command has been issued, but at least one job is still running

    • COMPLETED

      public static final OrderState COMPLETED
      All jobs have been completed successfully

    • FAILED

      public static final OrderState FAILED
      All jobs are finished, but at least one job failed

    • CLOSED

      public static final OrderState CLOSED
      The order has been closed, no further actions (except deletion) are possible

  • Method Details

    • values

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

    • isLegalTransition

      public boolean isLegalTransition(OrderState other)
      Check whether the transition to the other state is legal
      Parameters:
      other - the state to switch to
      Returns:
      true, if the transition is legal, false otherwise