Enum Class ResultType

Object
Enum<ResultType>
ResultType
All Implemented Interfaces:
Serializable, Comparable<ResultType>, Constable, Enumerator

public enum ResultType extends Enum<ResultType> implements Enumerator
A representation of the literals of the enumeration 'Result Type', and utility methods for working with them.
See Also:
  • Enum Constant Details

  • Field Details

    • RESULTS_VALUE

      public static final int RESULTS_VALUE
      The 'Results' literal value. Include results in the response.
      See Also:
    • HITS_VALUE

      public static final int HITS_VALUE
      The 'Hits' literal value. Provide a result set summary, but no results.
      See Also:
    • VALIDATE_VALUE

      public static final int VALIDATE_VALUE
      The 'Validate' literal value. Validate the request and return an Acknowledgement message if it is valid. Continue processing the request asynchronously.
      See Also:
    • VALUES

      public static final List<ResultType> VALUES
      A public read-only list of all the 'Result Type' enumerators.
  • Method Details

    • values

      public static ResultType[] 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 ResultType 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
    • get

      public static ResultType get(String literal)
      Returns the 'Result Type' literal with the specified literal value.
    • getByName

      public static ResultType getByName(String name)
      Returns the 'Result Type' literal with the specified name.
    • get

      public static ResultType get(int value)
      Returns the 'Result Type' literal with the specified integer value.
    • getValue

      public int getValue()
      Specified by:
      getValue in interface Enumerator
    • getName

      public String getName()
      Specified by:
      getName in interface Enumerator
    • getLiteral

      public String getLiteral()
      Specified by:
      getLiteral in interface Enumerator
    • toString

      public String toString()
      Returns the literal value of the enumerator, which is its string representation.
      Overrides:
      toString in class Enum<ResultType>