Enum OMAGServerInstanceErrorCode

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

    public enum OMAGServerInstanceErrorCode
    extends java.lang.Enum<OMAGServerInstanceErrorCode>
    implements ExceptionMessageSet
    The OMAGServerInstanceErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with OMAG Server instances within the OMAG Server Platform It is used in conjunction with all multi-tenant exceptions, both Checked and Runtime (unchecked). The 5 fields in the enum are:
    • HTTP Error Code - for translating between REST and JAVA Typically the numbers used are:
      • 500 - internal error
      • 400 - invalid parameters
      • 404 - not found
      • 409 - data conflict errors - eg item 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 consumer should correct the error
    • Method Detail

      • values

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

        public static OMAGServerInstanceErrorCode 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()
        JSON-style toString
        Overrides:
        toString in class java.lang.Enum<OMAGServerInstanceErrorCode>
        Returns:
        string of property names and values for this enum