Enum TexViewErrorCode

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

    public enum TexViewErrorCode
    extends java.lang.Enum<TexViewErrorCode>
    implements ExceptionMessageSet
    The TexViewErrorCode 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 TexViewErrorCode SERVICE_NOT_INITIALIZED
      • INVALID_CONFIG_PROPERTY

        public static final TexViewErrorCode INVALID_CONFIG_PROPERTY
      • VIEW_SERVICE_NULL_PLATFORM_NAME

        public static final TexViewErrorCode VIEW_SERVICE_NULL_PLATFORM_NAME
      • VIEW_SERVICE_NULL_SERVER_NAME

        public static final TexViewErrorCode VIEW_SERVICE_NULL_SERVER_NAME
      • VIEW_SERVICE_UNKNOWN_SERVER_NAME

        public static final TexViewErrorCode VIEW_SERVICE_UNKNOWN_SERVER_NAME
      • REPOSITORY_NOT_AVAILABLE

        public static final TexViewErrorCode REPOSITORY_NOT_AVAILABLE
      • PLATFORM_NOT_AVAILABLE

        public static final TexViewErrorCode PLATFORM_NOT_AVAILABLE
      • VIEW_SERVICE_REQUEST_BODY_MISSING

        public static final TexViewErrorCode VIEW_SERVICE_REQUEST_BODY_MISSING
      • TYPE_SYSTEM_ENTITY_DEF_MISSING

        public static final TexViewErrorCode TYPE_SYSTEM_ENTITY_DEF_MISSING
      • TYPE_SYSTEM_ENTITY_SUPERTYPE_NAME_MISSING

        public static final TexViewErrorCode TYPE_SYSTEM_ENTITY_SUPERTYPE_NAME_MISSING
      • TYPE_SYSTEM_ENTITY_SUPERTYPE_MISSING

        public static final TexViewErrorCode TYPE_SYSTEM_ENTITY_SUPERTYPE_MISSING
      • TYPE_SYSTEM_RELATIONSHIP_DEF_MISSING

        public static final TexViewErrorCode TYPE_SYSTEM_RELATIONSHIP_DEF_MISSING
      • TYPE_SYSTEM_RELATIONSHIP_END_DEF_MISSING

        public static final TexViewErrorCode TYPE_SYSTEM_RELATIONSHIP_END_DEF_MISSING
      • TYPE_SYSTEM_CLASSIFICATION_DEF_MISSING

        public static final TexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_DEF_MISSING
      • TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_NAME_MISSING

        public static final TexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_NAME_MISSING
      • TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_MISSING

        public static final TexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_MISSING
      • TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_NAME_MISSING

        public static final TexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_NAME_MISSING
      • TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_MISSING

        public static final TexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_MISSING
    • Method Detail

      • values

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

        public static TexViewErrorCode 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<TexViewErrorCode>
        Returns:
        string description