com.hyperion.css
Class CSSBaseException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.hyperion.css.CSSBaseException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
CSSException

public class CSSBaseException
extends java.lang.Exception

See Also:
Serialized Form

Field Summary
protected  long area_Code
           
protected  long error_Code
           
protected  java.lang.String[] errorArguments
           
protected  long errorCode
           
protected  java.lang.String errorMessage
           
protected  boolean hasErrorArguments
           
protected  boolean hasRootCause
           
protected  java.util.Locale locale
           
protected  int logLevel
           
protected  java.lang.String providerName
           
protected  java.util.ArrayList rootCausesList
           
protected  java.lang.Throwable rootException
           
protected  java.util.ArrayList rootMessagesList
           
 
Constructor Summary
  CSSBaseException()
          Deprecated.  
  CSSBaseException(long areaCode, long errorCode)
          Constructs a new exception with the specified error code.
  CSSBaseException(long areaCode, long errorCode, int logLevel)
          Constructs a new exception with the specified error code.
  CSSBaseException(long areaCode, long errorCode, java.lang.String[] errorArguments)
          Constructs a new exception with the specified error code.
  CSSBaseException(long areaCode, long errorCode, java.lang.String[] errorArguments, int logLevel)
          Constructs a new exception with the specified error code.
  CSSBaseException(long areaCode, long errorCode, java.lang.String[] errorArguments, java.lang.Throwable rootException)
          Constructs a new exception with the specified error code.
  CSSBaseException(long areaCode, long errorCode, java.lang.String[] errorArguments, java.lang.Throwable rootException, int logLevel)
          Constructs a new exception with the specified error code.
  CSSBaseException(long areaCode, long errorCode, java.lang.Throwable rootException)
          Constructs a new exception with the specified error code.
  CSSBaseException(long areaCode, long errorCode, java.lang.Throwable rootException, int logLevel)
          Constructs a new exception with the specified error code.
  CSSBaseException(java.util.Map context, java.lang.String errorCode)
           
  CSSBaseException(java.util.Map context, java.lang.String deleteGroupMembershipFailed, com.hyperion.css.common.CSSGroupMembership groupMembership)
           
  CSSBaseException(java.util.Map context, java.lang.String errorCode, java.util.Set<java.lang.String> failedList)
           
  CSSBaseException(java.util.Map context, java.lang.String errorCode, java.lang.String[] errorArguments)
           
  CSSBaseException(java.util.Map context, java.lang.String errorCode, java.lang.String[] errorArguments, java.lang.Throwable rootException)
           
  CSSBaseException(java.util.Map context, java.lang.String errorCode, java.lang.Throwable rootException)
           
  CSSBaseException(java.lang.String explanation)
          Deprecated.  
  CSSBaseException(java.lang.String explanation, long errorCode)
          Deprecated.  
protected CSSBaseException(java.lang.String callerFQCN, long areaCode, long errorCode)
          Constructs a new exception with the specified error code.
protected CSSBaseException(java.lang.String callerFQCN, long areaCode, long errorCode, int logLevel)
          Constructs a new exception with the specified error code.
protected CSSBaseException(java.lang.String callerFQCN, long areaCode, long errorCode, java.lang.String[] errorArguments)
          Constructs a new exception with the specified error code.This constructor to be used by sub CSSBaseException classes.
protected CSSBaseException(java.lang.String callerFQCN, long areaCode, long errorCode, java.lang.String[] errorArguments, int logLevel)
          Constructs a new exception with the specified error code.This constructor to be used by sub CSSBaseException classes.
protected CSSBaseException(java.lang.String callerFQCN, long areaCode, long errorCode, java.lang.String[] errorArguments, java.lang.Throwable rootException)
          Constructs a new exception with the specified error code.This constructor to be used by sub CSSBaseException classes.
protected CSSBaseException(java.lang.String callerFQCN, long areaCode, long errorCode, java.lang.String[] errorArguments, java.lang.Throwable rootException, int logLevel)
          Constructs a new exception with the specified error code.This constructor to be used by sub CSSBaseException classes.
protected CSSBaseException(java.lang.String callerFQCN, long areaCode, long errorCode, java.lang.Throwable rootException)
          Constructs a new exception with the specified error code.This constructor to be used by sub CSSBaseException classes.
protected CSSBaseException(java.lang.String callerFQCN, long areaCode, long errorCode, java.lang.Throwable rootException, int logLevel)
          Constructs a new exception with the specified error code.This constructor to be used by sub CSSBaseException classes.
  CSSBaseException(java.lang.String explanation, java.lang.Throwable rootException)
          Deprecated.  
  CSSBaseException(java.lang.Throwable rootException)
          Deprecated.  
 
Method Summary
 long getCSSAreaCode()
          Returns the area code of the exception.
 long getCSSErrorCode()
          Returns the error code of the exception.
 java.lang.String getErrorCode()
          Deprecated.  
 java.lang.Object getExceptionInfo()
           
 java.lang.String getMessage()
          Returns the detail message string of this exception.
 java.lang.String getMessage(java.util.Locale locale)
          Returns the detail localized message string of this exception for the specified locale.
 java.lang.String getProvider()
          Deprecated.  
 java.lang.Throwable getRootCause()
           Obtain the root exception, if any.
 java.lang.Throwable[] getRootCauses()
          Returns all the root causes of this exception.
 java.lang.String[] getRootMessages()
          Returns the messages of all the root causes of this exception.
 void setErrorCode(long errorCode)
          Deprecated.  
 void setExceptionInfo(java.lang.Object exceptionInfo)
           
 void setLocale(java.util.Locale locale)
           
 void setRootCause(java.lang.Throwable exception)
           Sets the cause for this exception.
 java.lang.String toString()
           Returns the string representation.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

rootException

protected java.lang.Throwable rootException

errorArguments

protected java.lang.String[] errorArguments

logLevel

protected int logLevel

errorCode

protected long errorCode

error_Code

protected long error_Code

area_Code

protected long area_Code

locale

protected java.util.Locale locale

providerName

protected java.lang.String providerName

errorMessage

protected java.lang.String errorMessage

hasErrorArguments

protected boolean hasErrorArguments

hasRootCause

protected boolean hasRootCause

rootCausesList

protected java.util.ArrayList rootCausesList

rootMessagesList

protected java.util.ArrayList rootMessagesList
Constructor Detail

CSSBaseException

public CSSBaseException(long areaCode,
                        long errorCode)
Constructs a new exception with the specified error code.

This constructor will log the error message by default in

  • CSSLogger.ERROR_LEVEL.

    The error codes are defined in

  • CSSErrorCodeIF

    Sample use of the exception:

     
     throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR);
     
     

    Parameters:
    areaCode - - the area code of the error occured.
    errorCode - - the error code of the error message. The detail message is saved for later retrieval by the getMessage() method.

  • CSSBaseException

    protected CSSBaseException(java.lang.String callerFQCN,
                               long areaCode,
                               long errorCode)
    Constructs a new exception with the specified error code. This constructor to be used by sub CSSBaseException classes.

    This constructor will log the error message by default in

  • CSSLogger.ERROR_LEVEL.

    The error codes are defined in

  • CSSErrorCodeIF

    Sample use of the exception:

     
     throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR);
     
     

    Parameters:
    callerFQCN - - the wrapper class' fully qualified class name.
    areaCode - - the area code of the error occured.
    errorCode - - the error code of the error message. The detail message is saved for later retrieval by the getMessage() method.

  • CSSBaseException

    public CSSBaseException(long areaCode,
                            long errorCode,
                            java.lang.String[] errorArguments)
    Constructs a new exception with the specified error code.

    This constructor will log the error message by default in

  • CSSLogger.ERROR_LEVEL.

    The error codes are defined in

  • CSSErrorCodeIF

    Sample use of the exception:

     
     throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR,
             new String[] { "argurments" });
     
     

    Parameters:
    areaCode - - the area code of the error occured.
    errorCode - - the error code of the error message. The detail message is saved for later retrieval by the getMessage() method.
    errorArguments - - the error arguments to be assinged into error message. A null arguments is not considered as arguments.

  • CSSBaseException

    protected CSSBaseException(java.lang.String callerFQCN,
                               long areaCode,
                               long errorCode,
                               java.lang.String[] errorArguments)
    Constructs a new exception with the specified error code.This constructor to be used by sub CSSBaseException classes.

    This constructor will log the error message by default in

  • CSSLogger.ERROR_LEVEL.

    The error codes are defined in

  • CSSErrorCodeIF

    Sample use of the exception:

     
     throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR,
             new String[] { "argurments" });
     
     

    Parameters:
    callerFQCN - - the wrapper class' fully qualified class name.
    areaCode - - the area code of the error occured.
    errorCode - - the error code of the error message. The detail message is saved for later retrieval by the getMessage() method.
    errorArguments - - the error arguments to be assinged into error message.

  • CSSBaseException

    public CSSBaseException(long areaCode,
                            long errorCode,
                            int logLevel)
    Constructs a new exception with the specified error code.

    This constructor will log the error message for the specified log level.

    The error codes are defined in

  • CSSErrorCodeIF

    The level should be one of the following:

  • CSSLogger.FATAL_LEVEL
  • CSSLogger.ERROR_LEVEL
  • CSSLogger.WARN_LEVEL
  • CSSLogger.INFO_LEVEL
  • CSSLogger.DEBUG_LEVEL

    Sample use of the exception:

     
     throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR, CSSLogger.DEBUG_LEVEL);
     
     

    Parameters:
    areaCode - - the area code of the error occured.
    errorCode - - the error code of the error message. The detail message is saved for later retrieval by the getMessage() method.
    logLevel - - the level of the logging request

  • CSSBaseException

    protected CSSBaseException(java.lang.String callerFQCN,
                               long areaCode,
                               long errorCode,
                               int logLevel)
    Constructs a new exception with the specified error code. This constructor to be used by sub CSSBaseException classes.

    This constructor will log the error message for the specified log level.

    The error codes are defined in

  • CSSErrorCodeIF

    The level should be one of the following:

  • CSSLogger.FATAL_LEVEL
  • CSSLogger.ERROR_LEVEL
  • CSSLogger.WARN_LEVEL
  • CSSLogger.INFO_LEVEL
  • CSSLogger.DEBUG_LEVEL

    Sample use of the exception:

     
     throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR, CSSLogger.DEBUG_LEVEL);
     
     

    Parameters:
    callerFQCN - - the wrapper class' fully qualified class name.
    areaCode - - the area code of the error occured.
    errorCode - - the error code of the error message. The detail message is saved for later retrieval by the getMessage() method.
    logLevel - - the level of the logging request

  • CSSBaseException

    public CSSBaseException(long areaCode,
                            long errorCode,
                            java.lang.String[] errorArguments,
                            int logLevel)
    Constructs a new exception with the specified error code.

    This constructor will log the error message for the specified log level.

    The error codes are defined in

  • CSSErrorCodeIF

    The level should be one of the following:

  • CSSLogger.FATAL_LEVEL
  • CSSLogger.ERROR_LEVEL
  • CSSLogger.WARN_LEVEL
  • CSSLogger.INFO_LEVEL
  • CSSLogger.DEBUG_LEVEL

    Sample use of the exception:

     
     throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR,
             new String[] { "argurments" }, CSSLogger.DEBUG_LEVEL);
     
     

    Parameters:
    areaCode - - the area code of the error occured.
    errorCode - - the error code of the error message. The detail message is saved for later retrieval by the getMessage() method.
    errorArguments - - the error arguments to be assinged into error message.
    logLevel - - the level of the logging request

  • CSSBaseException

    protected CSSBaseException(java.lang.String callerFQCN,
                               long areaCode,
                               long errorCode,
                               java.lang.String[] errorArguments,
                               int logLevel)
    Constructs a new exception with the specified error code.This constructor to be used by sub CSSBaseException classes.

    This constructor will log the error message for the specified log level.

    The error codes are defined in

  • CSSErrorCodeIF

    The level should be one of the following:

  • CSSLogger.FATAL_LEVEL
  • CSSLogger.ERROR_LEVEL
  • CSSLogger.WARN_LEVEL
  • CSSLogger.INFO_LEVEL
  • CSSLogger.DEBUG_LEVEL

    Sample use of the exception:

     
     throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR,
             new String[] { "argurments" }, CSSLogger.DEBUG_LEVEL);
     
     

    Parameters:
    callerFQCN - - the wrapper class' fully qualified class name.
    areaCode - - the area code of the error occured.
    errorCode - - the error code of the error message. The detail message is saved for later retrieval by the getMessage() method.
    errorArguments - - the error arguments to be assinged into error message.
    logLevel - - the level of the logging request

  • CSSBaseException

    public CSSBaseException(long areaCode,
                            long errorCode,
                            java.lang.Throwable rootException)
    Constructs a new exception with the specified error code.

    This constructor will log the error message by default in

  • CSSLogger.ERROR_LEVEL.

    The stack trace would be logged only if DEBUG level is enabled else only the error message is logged.

    The error codes are defined in
  • CSSErrorCodeIF

    Sample use of the exception:

     
     throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR, rootException);
     
     

    Parameters:
    areaCode - - the area code of the error occured.
    errorCode - - the error code of the error message. The detail message is saved for later retrieval by the getMessage() method.
    rootException - - the root cause (which is saved for later retrieval by the getRootCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

  • CSSBaseException

    protected CSSBaseException(java.lang.String callerFQCN,
                               long areaCode,
                               long errorCode,
                               java.lang.Throwable rootException)
    Constructs a new exception with the specified error code.This constructor to be used by sub CSSBaseException classes.

    This constructor will log the error message by default in

  • CSSLogger.ERROR_LEVEL.

    The stack trace would be logged only if DEBUG level is enabled else only the error message is logged.

    The error codes are defined in
  • CSSErrorCodeIF

    Sample use of the exception:

     
     throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR, rootException);
     
     

    Parameters:
    callerFQCN - - the wrapper class' fully qualified class name.
    areaCode - - the area code of the error occured.
    errorCode - - the error code of the error message. The detail message is saved for later retrieval by the getMessage() method.
    rootException - - the root cause (which is saved for later retrieval by the getRootCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

  • CSSBaseException

    public CSSBaseException(long areaCode,
                            long errorCode,
                            java.lang.Throwable rootException,
                            int logLevel)
    Constructs a new exception with the specified error code.

    This constructor will log the error message for the specified log level.

    The stack trace would be logged only if DEBUG level is enabled else only the error message is logged.

    The error codes are defined in
  • CSSErrorCodeIF

    The level should be one of the following:

  • CSSLogger.FATAL_LEVEL
  • CSSLogger.ERROR_LEVEL
  • CSSLogger.WARN_LEVEL
  • CSSLogger.INFO_LEVEL
  • CSSLogger.DEBUG_LEVEL

    Sample use of the exception:

     
     throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR, rootException,
             CSSLogger.DEBUG_LEVEL);
     
     

    Parameters:
    areaCode - - the area code of the error occured.
    errorCode - - the error code of the error message. The detail message is saved for later retrieval by the getMessage() method.
    rootException - - the root cause (which is saved for later retrieval by the getRootCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
    logLevel - - the level of the logging request

  • CSSBaseException

    protected CSSBaseException(java.lang.String callerFQCN,
                               long areaCode,
                               long errorCode,
                               java.lang.Throwable rootException,
                               int logLevel)
    Constructs a new exception with the specified error code.This constructor to be used by sub CSSBaseException classes.

    This constructor will log the error message for the specified log level.

    The stack trace would be logged only if DEBUG level is enabled else only the error message is logged.

    The error codes are defined in
  • CSSErrorCodeIF

    The level should be one of the following:

  • CSSLogger.FATAL_LEVEL
  • CSSLogger.ERROR_LEVEL
  • CSSLogger.WARN_LEVEL
  • CSSLogger.INFO_LEVEL
  • CSSLogger.DEBUG_LEVEL

    Sample use of the exception:

     
     throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR, rootException,
             CSSLogger.DEBUG_LEVEL);
     
     

    Parameters:
    callerFQCN - - the wrapper class' fully qualified class name.
    areaCode - - the area code of the error occured.
    errorCode - - the error code of the error message. The detail message is saved for later retrieval by the getMessage() method.
    rootException - - the root cause (which is saved for later retrieval by the getRootCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
    logLevel - - the level of the logging request

  • CSSBaseException

    public CSSBaseException(long areaCode,
                            long errorCode,
                            java.lang.String[] errorArguments,
                            java.lang.Throwable rootException)
    Constructs a new exception with the specified error code.

    This constructor will log the error message by default in

  • CSSLogger.ERROR_LEVEL.

    The stack trace would be logged only if DEBUG level is enabled else only the error message is logged.

    The error codes are defined in
  • CSSErrorCodeIF

    Sample use of the exception:

     
     throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR,
             new String[] { "argurments" }, rootException);
     
     

    Parameters:
    areaCode - - the area code of the error occured.
    errorCode - - the error code of the error message. The detail message is saved for later retrieval by the getMessage() method.
    errorArguments - - the error arguments to be assinged into error message.
    rootException - - the root cause (which is saved for later retrieval by the getRootCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

  • CSSBaseException

    protected CSSBaseException(java.lang.String callerFQCN,
                               long areaCode,
                               long errorCode,
                               java.lang.String[] errorArguments,
                               java.lang.Throwable rootException)
    Constructs a new exception with the specified error code.This constructor to be used by sub CSSBaseException classes.

    This constructor will log the error message by default in

  • CSSLogger.ERROR_LEVEL.

    The stack trace would be logged only if DEBUG level is enabled else only the error message is logged.

    The error codes are defined in
  • CSSErrorCodeIF

    Sample use of the exception:

     
     throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR,
             new String[] { "argurments" }, rootException);
     
     

    Parameters:
    callerFQCN - - the wrapper class' fully qualified class name.
    areaCode - - the area code of the error occured.
    errorCode - - the error code of the error message. The detail message is saved for later retrieval by the getMessage() method.
    errorArguments - - the error arguments to be assinged into error message.
    rootException - - the root cause (which is saved for later retrieval by the getRootCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

  • CSSBaseException

    public CSSBaseException(long areaCode,
                            long errorCode,
                            java.lang.String[] errorArguments,
                            java.lang.Throwable rootException,
                            int logLevel)
    Constructs a new exception with the specified error code.

    This constructor will log the error message for the specified log level.

    The stack trace would be logged only if DEBUG level is enabled else only the error message is logged.

    The error codes are defined in
  • CSSErrorCodeIF

    The level should be one of the following:

  • CSSLogger.FATAL_LEVEL
  • CSSLogger.ERROR_LEVEL
  • CSSLogger.WARN_LEVEL
  • CSSLogger.INFO_LEVEL
  • CSSLogger.DEBUG_LEVEL

    Sample use of the exception:

     
     throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR,
             new String[] { "argurments" }, rootException);
     
     

    Parameters:
    areaCode - - the area code of the error occured.
    errorCode - - the error code of the error message. The detail message is saved for later retrieval by the getMessage() method.
    errorArguments - - the error arguments to be assinged into error message.
    rootException - - the root cause (which is saved for later retrieval by the getRootCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
    logLevel - - the level of the logging request

  • CSSBaseException

    protected CSSBaseException(java.lang.String callerFQCN,
                               long areaCode,
                               long errorCode,
                               java.lang.String[] errorArguments,
                               java.lang.Throwable rootException,
                               int logLevel)
    Constructs a new exception with the specified error code.This constructor to be used by sub CSSBaseException classes.

    This constructor will log the error message for the specified log level.

    The stack trace would be logged only if DEBUG level is enabled else only the error message is logged.

    The error codes are defined in
  • CSSErrorCodeIF

    The level should be one of the following:

  • CSSLogger.FATAL_LEVEL
  • CSSLogger.ERROR_LEVEL
  • CSSLogger.WARN_LEVEL
  • CSSLogger.INFO_LEVEL
  • CSSLogger.DEBUG_LEVEL

    Sample use of the exception:

     
     throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR,
             new String[] { "argurments" }, rootException);
     
     

    Parameters:
    callerFQCN - - the wrapper class' fully qualified class name.
    areaCode - - the area code of the error occured.
    errorCode - - the error code of the error message. The detail message is saved for later retrieval by the getMessage() method.
    errorArguments - - the error arguments to be assinged into error message.
    rootException - - the root cause (which is saved for later retrieval by the getRootCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
    logLevel - - the level of the logging request

  • CSSBaseException

    public CSSBaseException(java.lang.String explanation)
    Deprecated. 

    Constructor that accepts the message detailing the exception.

    Parameters:
    explanation - String that states the reason for the exception.

    CSSBaseException

    public CSSBaseException(java.lang.String explanation,
                            long errorCode)
    Deprecated. 

    Constructor that accepts a message and an errorCode detailing information about this exception.

    Parameters:
    explanation - String that states the reason for the exception.
    errorCode - Specifies the type of error and is associated with an exception class.

    CSSBaseException

    public CSSBaseException(java.lang.Throwable rootException)
    Deprecated. 

    Creates a new exception with the cause.

    Parameters:
    rootException - The exception that caused this exception.

    CSSBaseException

    public CSSBaseException(java.lang.String explanation,
                            java.lang.Throwable rootException)
    Deprecated. 

    Creates a new exception with a message and a cause.

    Parameters:
    explanation - String that states the reason for the exception.
    rootException - The exception that caused this exception.

    CSSBaseException

    public CSSBaseException()
    Deprecated. 

    Creates a new exception with null as its message.


    CSSBaseException

    public CSSBaseException(java.util.Map context,
                            java.lang.String errorCode)

    CSSBaseException

    public CSSBaseException(java.util.Map context,
                            java.lang.String errorCode,
                            java.lang.String[] errorArguments)

    CSSBaseException

    public CSSBaseException(java.util.Map context,
                            java.lang.String errorCode,
                            java.util.Set<java.lang.String> failedList)

    CSSBaseException

    public CSSBaseException(java.util.Map context,
                            java.lang.String errorCode,
                            java.lang.Throwable rootException)

    CSSBaseException

    public CSSBaseException(java.util.Map context,
                            java.lang.String errorCode,
                            java.lang.String[] errorArguments,
                            java.lang.Throwable rootException)

    CSSBaseException

    public CSSBaseException(java.util.Map context,
                            java.lang.String deleteGroupMembershipFailed,
                            com.hyperion.css.common.CSSGroupMembership groupMembership)
    Method Detail

    getMessage

    public java.lang.String getMessage()
    Returns the detail message string of this exception.

    The message will be prefixed with area code and error code like

    AREA_CODE:ERROR_CODE:ERROR_MESSAGE (e.g, 10:100:General Error Occured).

    Overrides:
    getMessage in class java.lang.Throwable
    Returns:
    the detail message string of this Throwable instance (which may be null).

    getMessage

    public java.lang.String getMessage(java.util.Locale locale)
    Returns the detail localized message string of this exception for the specified locale.

    The message will be prefixed with area code and error code like

    AREA_CODE:ERROR_CODE:ERROR_MESSAGE (e.g, 10:100:General Error Occured).

    Please note that if the locale is not specified, the default locale set for the system is used.

    Parameters:
    locale - - the locale object to localize the message
    Returns:
    the detail message string of this Throwable instance (which may be null).

    getRootMessages

    public java.lang.String[] getRootMessages()
    Returns the messages of all the root causes of this exception.

    Returns:
    a String[] of root messages.

    getRootCauses

    public java.lang.Throwable[] getRootCauses()
    Returns all the root causes of this exception.

    Returns:
    a Throwable[] of root causes

    setRootCause

    public void setRootCause(java.lang.Throwable exception)

    Sets the cause for this exception.

    Parameters:
    exception - The reason for the exception.

    getRootCause

    public java.lang.Throwable getRootCause()

    Obtain the root exception, if any.

    Returns:
    the root exception, or null if there is no root exception

    toString

    public java.lang.String toString()

    Returns the string representation.

    Overrides:
    toString in class java.lang.Throwable
    Returns:
    String

    getErrorCode

    public java.lang.String getErrorCode()
    Deprecated. 

    The error code.

    Returns:
    long - the error code

    setErrorCode

    public void setErrorCode(long errorCode)
    Deprecated. 

    Sets the error code.

    Parameters:
    errorCode - Specifies the type of error and is associated with an exception class.

    getProvider

    public java.lang.String getProvider()
    Deprecated. 

    Returns the provider name where this exception originated.

    Returns:
    String - the name of the provider
    Since:
    CSS v2.5

    setLocale

    public void setLocale(java.util.Locale locale)
    See Also:
    CSSAppExceptionIF.setLocale(Locale)

    getCSSErrorCode

    public long getCSSErrorCode()
    Returns the error code of the exception.

    This specifies the error number in the resource bundle associated with the error message

    For e.g. if the exception insatnce is - CSSIllegalArgumentException(CSSAreaCodeIF.NATIVE_USER_PROVG_AREA_CODE, CSSErrorCodeIF.NULL_ARGUMENT_ERROR, new String[]{CSSErrorCodeIF.APP_INSTANCE_ARG})

    Returns the error code CSSErrorCodeIF.NULL_ARGUMENT_ERROR

    Returns:
    error code.

    getCSSAreaCode

    public long getCSSAreaCode()
    Returns the area code of the exception.

    This specifies the area of the CSS application from which the exception is thrown.

    For e.g. if the exception instance is - CSSIllegalArgumentException(CSSAreaCodeIF.NATIVE_USER_PROVG_AREA_CODE, CSSErrorCodeIF.NULL_ARGUMENT_ERROR, new String[]{CSSErrorCodeIF.APP_INSTANCE_ARG})

    Returns the area code CSSAreaCodeIF.NATIVE_USER_PROVG_AREA_CODE

    Returns:
    area code
    See Also:
    CSSAreaCodeIF

    setExceptionInfo

    public void setExceptionInfo(java.lang.Object exceptionInfo)
    Parameters:
    exceptionInfo - the exceptionInfo to set

    getExceptionInfo

    public java.lang.Object getExceptionInfo()
    Returns:
    the exceptionInfo


    Copyright © 2005-2009 Oracle Corporation.