Package com.caplin.datasource

Enum SubjectStatus

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SubjectStatus>
    public enum SubjectStatus
extends java.lang.Enum<SubjectStatus>
    Enumeration that defines the status values that a subject can have.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Info
      Informational message.
      Limited
      One or more of the non-required DataSources for this object are down or have sent an explicit state status message
      NotMapped
      The subject is no longer required for mapping.
      Ok
      The subject's data is valid.
      Stale
      The subject's data may not be valid.
      Unknown
      Indicates that an unknown status code has been supplied.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getCode()
      Gets the integer code for this status
      static SubjectStatus getServiceStatusForCode​(int code)
      Gets the ServiceStatus for the specified code.
      static SubjectStatus valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SubjectStatus[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • Info

        public static final SubjectStatus Info
        Informational message.

      • Ok

        public static final SubjectStatus Ok
        The subject's data is valid.

      • Stale

        public static final SubjectStatus Stale
        The subject's data may not be valid.

      • NotMapped

        public static final SubjectStatus NotMapped
        The subject is no longer required for mapping. This status message is consumed internally by the library and will not be seen by user code and should not be sent by your application.

      • Limited

        public static final SubjectStatus Limited
        One or more of the non-required DataSources for this object are down or have sent an explicit state status message

      • Unknown

        public static final SubjectStatus Unknown
        Indicates that an unknown status code has been supplied.

    • Method Detail

      • values

        public static SubjectStatus[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (SubjectStatus c : SubjectStatus.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SubjectStatus valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getServiceStatusForCode

        public static SubjectStatus getServiceStatusForCode​(int code)
        Gets the ServiceStatus for the specified code.
        Parameters:
        code - The DataSource status code value.
        Returns:
        The ServiceStatus that corresponds to the specified code, or Unknown if an unknown code is specified.

      • getCode

        public int getCode()
        Gets the integer code for this status
        Returns:
        The internal integer code used by the Transformer core to represent this service status.