Skip navigation links


com.thortech.xl.gc.exception
Class ProviderOperationsException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.thortech.xl.gc.exception.ProviderOperationsException

All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public final class ProviderOperationsException
extends java.lang.Exception
implements java.lang.Cloneable

This is generic exception raised while using Provider operations.

See Also:
Serialized Form

Field Summary
 java.lang.String isMessage
          The detailed message.

 

Constructor Summary
ProviderOperationsException()
          Creates a new tcAPIException object.
ProviderOperationsException(java.lang.String isMessage)
          Constructs a new tcAPIException with the specified detail message.
ProviderOperationsException(java.lang.String isMessage, java.lang.Exception ex)
           
ProviderOperationsException(java.lang.String errorCode, java.lang.String isMessage)
          Constructs a new tcAPIException with the specified error code and detail message.

 

Method Summary
 java.lang.Object 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.
 java.lang.String getErrorCode()
          Returns the error code associated with API exception
 java.lang.String getMessage()
          Returns the error message associated with API exception
 java.lang.Object getReturnValue()
          Returns the object that needed to be returned by the API when the API exception occurred.
 void SetErrorCode(java.lang.String code)
          Method to set the Error code on API Exception
 void SetMessage(java.lang.String message)
          Method to set the Error message on API Exception
 void setReturnValue(java.lang.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 transactions

 

Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

isMessage

public java.lang.String isMessage
The detailed message. The detailed message is saved for later retrieval by the Throwable.getMessage() method.

Constructor Detail

ProviderOperationsException

public ProviderOperationsException()
Creates a new tcAPIException object.

ProviderOperationsException

public ProviderOperationsException(java.lang.String isMessage)
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.

ProviderOperationsException

public ProviderOperationsException(java.lang.String errorCode,
                                   java.lang.String isMessage)
Constructs a new tcAPIException with the specified error code and detail message.
Parameters:
errorCode - the error code
isMessage - the detailed message. The detailed message is saved for later retrieval by the Throwable.getMessage() method.

ProviderOperationsException

public ProviderOperationsException(java.lang.String isMessage,
                                   java.lang.Exception ex)

Method Detail

setReturnValue

public void setReturnValue(java.lang.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 transactions
Parameters:
retval - the object that needs to be returned
Since:
8.0

getReturnValue

public java.lang.Object 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

public java.lang.Object 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.
Overrides:
clone in class java.lang.Object
Returns:
java.lang.Object
Throws:
java.lang.Error - Error if any of the components cannot be cloned

SetErrorCode

public void SetErrorCode(java.lang.String code)
Method to set the Error code on API Exception
Parameters:
code, - error code to be set

getErrorCode

public java.lang.String getErrorCode()
Returns the error code associated with API exception
Returns:
the error code associated with the exception

SetMessage

public void SetMessage(java.lang.String message)
Method to set the Error message on API Exception
Parameters:
message, - error message to be set

getMessage

public java.lang.String getMessage()
Returns the error message associated with API exception
Overrides:
getMessage in class java.lang.Throwable
Returns:
the error message associated with the exception

Skip navigation links


Copyright © 2010, Oracle and/or its affiliates. All rights reserved.