Enum RexViewErrorCode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<RexViewErrorCode>, ExceptionMessageSet

    public enum RexViewErrorCode
    extends java.lang.Enum<RexViewErrorCode>
    implements ExceptionMessageSet
    The RexViewErrorCode is used to define first failure data capture (FFDC) for errors that occur within the OMVS It is used in conjunction with all OMVS Exceptions. The 5 fields in the enum are:
    • HTTP Error Code for translating between REST and JAVA. Typically the numbers used are:
      • 500: internal error
      • 501: not implemented
      • 503: Service not available
      • 400: invalid parameters
      • 401: unauthorized
      • 404: not found
      • 405: method not allowed
      • 409: data conflict errors, for example an item is already defined
    • Error Message Id: to uniquely identify the message
    • Error Message Text: includes placeholder to allow additional values to be captured
    • SystemAction: describes the result of the error
    • UserAction: describes how a user should correct the error
    • Enum Constant Detail

      • SERVICE_NOT_INITIALIZED

        public static final RexViewErrorCode SERVICE_NOT_INITIALIZED
      • INVALID_CONFIG_PROPERTY

        public static final RexViewErrorCode INVALID_CONFIG_PROPERTY
      • VIEW_SERVICE_NULL_PLATFORM_NAME

        public static final RexViewErrorCode VIEW_SERVICE_NULL_PLATFORM_NAME
      • REPOSITORY_NOT_AVAILABLE

        public static final RexViewErrorCode REPOSITORY_NOT_AVAILABLE
      • PLATFORM_NOT_AVAILABLE

        public static final RexViewErrorCode PLATFORM_NOT_AVAILABLE
      • ENTITY_NOT_KNOWN_IN_REPOSITORY

        public static final RexViewErrorCode ENTITY_NOT_KNOWN_IN_REPOSITORY
      • ENTITY_NOT_KNOWN_IN_ENTERPRISE

        public static final RexViewErrorCode ENTITY_NOT_KNOWN_IN_ENTERPRISE
      • RELATIONSHIP_NOT_KNOWN_IN_REPOSITORY

        public static final RexViewErrorCode RELATIONSHIP_NOT_KNOWN_IN_REPOSITORY
      • RELATIONSHIP_NOT_KNOWN_IN_ENTERPRISE

        public static final RexViewErrorCode RELATIONSHIP_NOT_KNOWN_IN_ENTERPRISE
      • VIEW_SERVICE_REQUEST_BODY_MISSING

        public static final RexViewErrorCode VIEW_SERVICE_REQUEST_BODY_MISSING
      • FUNCTION_NOT_SUPPORTED_ERROR

        public static final RexViewErrorCode FUNCTION_NOT_SUPPORTED_ERROR
      • TYPE_SYSTEM_ENTITY_SUPERTYPE_NAME_MISSING

        public static final RexViewErrorCode TYPE_SYSTEM_ENTITY_SUPERTYPE_NAME_MISSING
      • TYPE_SYSTEM_ENTITY_SUPERTYPE_MISSING

        public static final RexViewErrorCode TYPE_SYSTEM_ENTITY_SUPERTYPE_MISSING
      • TYPE_SYSTEM_ENTITY_DEF_MISSING

        public static final RexViewErrorCode TYPE_SYSTEM_ENTITY_DEF_MISSING
      • TYPE_SYSTEM_RELATIONSHIP_END_DEF_MISSING

        public static final RexViewErrorCode TYPE_SYSTEM_RELATIONSHIP_END_DEF_MISSING
      • TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_NAME_MISSING

        public static final RexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_NAME_MISSING
      • TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_MISSING

        public static final RexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_MISSING
      • TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_NAME_MISSING

        public static final RexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_NAME_MISSING
      • TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_MISSING

        public static final RexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_MISSING
      • TYPE_SYSTEM_CLASSIFICATION_DEF_MISSING

        public static final RexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_DEF_MISSING
      • HISTORICAL_FUNCTION_NOT_SUPPORTED

        public static final RexViewErrorCode HISTORICAL_FUNCTION_NOT_SUPPORTED
      • INVALID_AS_OF_DATETIME

        public static final RexViewErrorCode INVALID_AS_OF_DATETIME
    • Method Detail

      • values

        public static RexViewErrorCode[] 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 (RexViewErrorCode c : RexViewErrorCode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static RexViewErrorCode 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
      • getMessageDefinition

        public ExceptionMessageDefinition getMessageDefinition​(java.lang.String... params)
        Retrieve a message definition object for an exception. This method is used when there are values to be inserted into the message.
        Specified by:
        getMessageDefinition in interface ExceptionMessageSet
        Parameters:
        params - array of parameters (all strings). They are inserted into the message according to the numbering in the message text.
        Returns:
        message definition object.
      • toString

        public java.lang.String toString()
        toString() JSON-style
        Overrides:
        toString in class java.lang.Enum<RexViewErrorCode>
        Returns:
        string description