Module org.cruk.clarity.api
Package com.genologics.ri.step

Enum ProcessState

java.lang.Object
java.lang.Enum<ProcessState>
com.genologics.ri.step.ProcessState
All Implemented Interfaces:
Serializable, Comparable<ProcessState>, java.lang.constant.Constable
public enum ProcessState extends Enum<ProcessState>
An enumeration of the values possible in the ProcessStep.currentState attribute. This enumeration isn't actually an enumeration in the XML schemas, but it has a finite set of possible values and it's easier to work with an enumeration in Java code than just a string.

  • Enum Constant Details

    • STARTED

      public static final ProcessState STARTED
      The step state when the step is in the sample placement stage.

    • PLACEMENT

      public static final ProcessState PLACEMENT
      The step state when the step is in the sample placement stage.

    • ADD_REAGENT

      public static final ProcessState ADD_REAGENT
      The step state when the step is in the stage where barcodes are attached to the samples.

    • POOLING

      public static final ProcessState POOLING
      The step state when the step is in the pooling stage.

    • RECORD_DETAILS

      public static final ProcessState RECORD_DETAILS
      The step state when the step is in the record details stage.

    • NEXT_STEPS

      public static final ProcessState NEXT_STEPS
      The step state when the step is in the next steps stage.

    • COMPLETED

      public static final ProcessState COMPLETED
      The step state when the step is complete.

  • Field Details

    • displayName

      public final String displayName
      The display name of the state.

  • Method Details

    • values

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

    • valueOf

      public static ProcessState valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<ProcessState>

    • value

      public String value()

    • fromValue

      public static ProcessState fromValue(String str)
      Get the process state that has the given display name.
      Parameters:
      str - The display name, as returned from Clarity calls.
      Returns:
      The matching process state, or null if str is null.
      Throws:
      IllegalArgumentException - if str does not match the display name of a state.