Package com.thortech.xl.gc.exception
Class ProviderException
java.lang.Object
java.lang.Throwable
java.lang.Exception
com.thortech.xl.gc.exception.ProviderException
- All Implemented Interfaces:
Serializable
,Cloneable
This is generic exception raised while using Reconciliation Transport Provider.
- Version:
- Author:
- FirdausFraz
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new tcAPIException object.ProviderException
(String isMessage) Constructs a new tcAPIException with the specified detail message.ProviderException
(String isMessage, Exception ex) ProviderException
(String errorCode, String isMessage) Constructs a new tcAPIException with the specified error code and detail message. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates and returns a copy of this object.The method clone performs a specific cloning operation, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown.Returns the error code associated with API exceptionReturns the error message associated with API exceptionReturns the object that needed to be returned by the API when the API exception occurred.void
SetErrorCode
(String code) Method to set the Error code on API Exceptionvoid
SetMessage
(String message) Method to set the Error message on API Exceptionvoid
setReturnValue
(Object retval) Stores the return value that the API intended to send back when a API exception occurred by the failing of some of the transactionsMethods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
Field Details
-
isMessage
The detailed message. The detailed message is saved for later retrieval by the Throwable.getMessage() method.
-
-
Constructor Details
-
ProviderException
public ProviderException()Creates a new tcAPIException object. -
ProviderException
Constructs a new tcAPIException with the specified detail message.- Parameters:
isMessage
- the detailed message. The detailed message is saved for later retrieval by the Throwable.getMessage() method.
-
ProviderException
Constructs a new tcAPIException with the specified error code and detail message.- Parameters:
errorCode
- the error codeisMessage
- the detailed message. The detailed message is saved for later retrieval by the Throwable.getMessage() method.
-
ProviderException
-
-
Method Details
-
setReturnValue
Stores the return value that the API intended to send back when a API exception occurred by the failing of some of the transactions- Parameters:
retval
- the object that needs to be returned- Since:
- 8.0
-
getReturnValue
Returns the object that needed to be returned by the API when the API exception occurred.- Returns:
- an Object that need to be casted depending on the return value of the API that caused the API exception to happen
- Since:
- 8.0
-
clone
Creates and returns a copy of this object.The method clone performs a specific cloning operation, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown.- Returns:
- java.lang.Object
- Throws:
Error
- Error if any of the components cannot be cloned
-
SetErrorCode
Method to set the Error code on API Exception- Parameters:
code
- , error code to be set
-
getErrorCode
Returns the error code associated with API exception- Returns:
- the error code associated with the exception
-
SetMessage
Method to set the Error message on API Exception- Parameters:
message
- , error message to be set
-
getMessage
Returns the error message associated with API exception- Overrides:
getMessage
in classThrowable
- Returns:
- the error message associated with the exception
-