com.softwareag.centrasite.api.common.exception
Class CLLException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.softwareag.centrasite.api.common.exception.CLLException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
UserRegistrationException

public class CLLException
extends java.lang.Exception

Utility class that wraps all exceptions into the CLLException

See Also:
Serialized Form

Constructor Summary
CLLException(CLLMessage msgObject)
           
CLLException(CLLMessage msgObject, java.lang.Throwable cause)
           
 
Method Summary
static CLLException createCLLException(java.lang.String id, java.lang.Throwable throwable, java.lang.Object... positionalParams)
          Constructs a CLLException with the specified parameters.
 java.lang.String getAction()
          Returns the corrective actions on occurrence of a particular exception with the given message Id.
 java.lang.String getExplanation()
          Returns the explanation of an exception message with the given message Id.
 java.lang.String getMessage()
          Overrides Throwable.toString() method Returns the message text of an exception message with the given message Id.
 CLLMessage getMessageObject()
           
 java.lang.String toString()
          Overrides Throwable.toString() method Returns the message text of an exception message with the given message Id.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CLLException

public CLLException(CLLMessage msgObject)
Parameters:
msgObject - localized error message object

CLLException

public CLLException(CLLMessage msgObject,
                    java.lang.Throwable cause)
Parameters:
msgObject - localized error message object
cause - exception message
Method Detail

getMessage

public java.lang.String getMessage()
Overrides Throwable.toString() method Returns the message text of an exception message with the given message Id.

Overrides:
getMessage in class java.lang.Throwable
Returns:
message text of an exception message with the given message ID

getExplanation

public java.lang.String getExplanation()
Returns the explanation of an exception message with the given message Id.

Returns:
an explanation of an exception message with the given message ID

getAction

public java.lang.String getAction()
Returns the corrective actions on occurrence of a particular exception with the given message Id.

Returns:
corrective actions for a particular exception with the given message Id.

toString

public java.lang.String toString()
Overrides Throwable.toString() method Returns the message text of an exception message with the given message Id.

Overrides:
toString in class java.lang.Throwable
Returns:
message text of an exception message with the given message ID

getMessageObject

public CLLMessage getMessageObject()

createCLLException

public static CLLException createCLLException(java.lang.String id,
                                              java.lang.Throwable throwable,
                                              java.lang.Object... positionalParams)
Constructs a CLLException with the specified parameters.

Parameters:
id - unique message identifier
throwable - exceptions to wrap into CLLException
positionalParams - positional parameters for constructing an exception message
Returns:
CLLException if CLL fails to construct a CLLException with the specified parameters