|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
com.hyperion.css.CSSBaseException
public class CSSBaseException
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 |
---|
protected java.lang.Throwable rootException
protected java.lang.String[] errorArguments
protected int logLevel
protected long errorCode
protected long error_Code
protected long area_Code
protected java.util.Locale locale
protected java.lang.String providerName
protected java.lang.String errorMessage
protected boolean hasErrorArguments
protected boolean hasRootCause
protected java.util.ArrayList rootCausesList
protected java.util.ArrayList rootMessagesList
Constructor Detail |
---|
public CSSBaseException(long areaCode, long errorCode)
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);
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.protected CSSBaseException(java.lang.String callerFQCN, long areaCode, long errorCode)
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);
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.public CSSBaseException(long areaCode, long errorCode, java.lang.String[] errorArguments)
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" });
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.protected CSSBaseException(java.lang.String callerFQCN, long areaCode, long errorCode, java.lang.String[] errorArguments)
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" });
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.public CSSBaseException(long areaCode, long errorCode, int logLevel)
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);
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 requestprotected CSSBaseException(java.lang.String callerFQCN, long areaCode, long errorCode, int logLevel)
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);
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 requestpublic CSSBaseException(long areaCode, long errorCode, java.lang.String[] errorArguments, int logLevel)
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);
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 requestprotected CSSBaseException(java.lang.String callerFQCN, long areaCode, long errorCode, java.lang.String[] errorArguments, int logLevel)
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);
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 requestpublic CSSBaseException(long areaCode, long errorCode, java.lang.Throwable rootException)
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 inCSSErrorCodeIF
Sample use of the exception:
throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR, rootException);
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.)protected CSSBaseException(java.lang.String callerFQCN, long areaCode, long errorCode, java.lang.Throwable rootException)
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 inCSSErrorCodeIF
Sample use of the exception:
throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR, rootException);
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.)public CSSBaseException(long areaCode, long errorCode, java.lang.Throwable rootException, int logLevel)
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 inCSSErrorCodeIF
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);
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 requestprotected CSSBaseException(java.lang.String callerFQCN, long areaCode, long errorCode, java.lang.Throwable rootException, int logLevel)
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 inCSSErrorCodeIF
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);
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 requestpublic CSSBaseException(long areaCode, long errorCode, java.lang.String[] errorArguments, java.lang.Throwable rootException)
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 inCSSErrorCodeIF
Sample use of the exception:
throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR,
new String[] { "argurments" }, rootException);
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.)protected CSSBaseException(java.lang.String callerFQCN, long areaCode, long errorCode, java.lang.String[] errorArguments, java.lang.Throwable rootException)
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 inCSSErrorCodeIF
Sample use of the exception:
throw new CSSBaseException(CSSErrorCodeIF.GENERAL_ERROR,
new String[] { "argurments" }, rootException);
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.)public CSSBaseException(long areaCode, long errorCode, java.lang.String[] errorArguments, java.lang.Throwable rootException, int logLevel)
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 inCSSErrorCodeIF
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);
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 requestprotected CSSBaseException(java.lang.String callerFQCN, long areaCode, long errorCode, java.lang.String[] errorArguments, java.lang.Throwable rootException, int logLevel)
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 inCSSErrorCodeIF
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);
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 requestpublic CSSBaseException(java.lang.String explanation)
Constructor that accepts the message detailing the exception.
explanation
- String that states the reason for the exception.public CSSBaseException(java.lang.String explanation, long errorCode)
Constructor that accepts a message and an errorCode
detailing information about this exception.
explanation
- String that states the reason for the exception.errorCode
- Specifies the type of error and is associated with an exception class.public CSSBaseException(java.lang.Throwable rootException)
Creates a new exception with the cause.
rootException
- The exception that caused this exception.public CSSBaseException(java.lang.String explanation, java.lang.Throwable rootException)
Creates a new exception with a message and a cause.
explanation
- String that states the reason for the exception.rootException
- The exception that caused this exception.public CSSBaseException()
Creates a new exception with null
as its message.
public CSSBaseException(java.util.Map context, java.lang.String errorCode)
public CSSBaseException(java.util.Map context, java.lang.String errorCode, java.lang.String[] errorArguments)
public CSSBaseException(java.util.Map context, java.lang.String errorCode, java.util.Set<java.lang.String> failedList)
public CSSBaseException(java.util.Map context, java.lang.String errorCode, java.lang.Throwable rootException)
public CSSBaseException(java.util.Map context, java.lang.String errorCode, java.lang.String[] errorArguments, java.lang.Throwable rootException)
public CSSBaseException(java.util.Map context, java.lang.String deleteGroupMembershipFailed, com.hyperion.css.common.CSSGroupMembership groupMembership)
Method Detail |
---|
public java.lang.String getMessage()
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).
getMessage
in class java.lang.Throwable
public java.lang.String getMessage(java.util.Locale 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.
locale
- - the locale object to localize the message
public java.lang.String[] getRootMessages()
public java.lang.Throwable[] getRootCauses()
public void setRootCause(java.lang.Throwable exception)
Sets the cause for this exception.
exception
- The reason for the exception.public java.lang.Throwable getRootCause()
Obtain the root exception, if any.
public java.lang.String toString()
Returns the string representation.
toString
in class java.lang.Throwable
public java.lang.String getErrorCode()
The error code.
public void setErrorCode(long errorCode)
Sets the error code.
errorCode
- Specifies the type of error and is associated with an exception class.public java.lang.String getProvider()
Returns the provider name where this exception originated.
public void setLocale(java.util.Locale locale)
CSSAppExceptionIF.setLocale(Locale)
public long getCSSErrorCode()
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
public long getCSSAreaCode()
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
CSSAreaCodeIF
public void setExceptionInfo(java.lang.Object exceptionInfo)
exceptionInfo
- the exceptionInfo to setpublic java.lang.Object getExceptionInfo()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |