Package com.attivio.sdk.error

Class ExportStatusCode

  • All Implemented Interfaces:
    java.io.Serializable
    public final class ExportStatusCode
extends ErrorCode
    This class is a wrapper for a return code generated by the native process of an Export object. Instances of this class are immutable and, once obtained, can be queried for the integer value of the code they represent, or for the String text of that code. The text is localized, and queries will return text based on a provided locale. If no locale is provided, the default locale will be used.
    See Also:
    Serialized Form

    • Method Detail

      • getCodeText

        public java.lang.String getCodeText()
        Gets the text representation of the ExportStatusCode using the default Locale.
        Returns:
        A String containing the text for this ExportStatusCode.

      • getCodeText

        public java.lang.String getCodeText​(java.util.Locale locale)
        Gets the text representation of the ExportStatusCode using the provided Locale.
        Parameters:
        locale - The Locale to use when obtaining the ExportStatusCode text.
        Returns:
        A String containing the text for this ExportStatusCode.

      • toString

        public java.lang.String toString()
        Gets the text representation of the ExportStatusCode in the same way as getCodeText does.
        Overrides:
        toString in class ErrorCode
        Returns:
        A String containing the text for this ExportStatusCode

      • equals

        public boolean equals​(java.lang.Object obj)
        Determines if two ExportCodeText instances are equal, by testing the equality of their integer values.
        Overrides:
        equals in class ErrorCode
        Parameters:
        obj - The ExportStatusCode to test for equality with.
        Returns:
        A boolean representing the results of the equality test.