Package Thor.API.Exceptions

Class tcAPIException

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.thortech.xl.util.ThorException
Thor.API.Exceptions.tcAPIException
All Implemented Interfaces:
Serializable, Cloneable
public final class tcAPIException extends com.thortech.xl.util.ThorException implements Cloneable
This is generic exception raised while using API operations. For example if there is a problem while retrieving the information from the database this exception is raised.
Version:
$Revision: /main/17 $
Author:
evandana
See Also:

  • Field Details

    • isMessage

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

    • isSeverity

      public String isSeverity

  • Constructor Details

    • tcAPIException

      public tcAPIException()
      Creates a new tcAPIException object.

    • tcAPIException

      public tcAPIException(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.

    • tcAPIException

      public tcAPIException(String errorCode, 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.

    • tcAPIException

      public tcAPIException(String isMessage, Throwable ex)

  • Method Details

    • setReturnValue

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

    • getReturnValue

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

    • SetErrorCode

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

    • getErrorCode

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

    • SetMessage

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

    • getMessage

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

    • setSeverity

      public void setSeverity(String severity)
      Method to set the Severity of Error message on API Exception
      Parameters:
      severity - , severity of error message to be set
      Since:
      9.1

    • getSeverity

      public String getSeverity()
      Returns the Severity of error message associated with API exception
      Returns:
      the severity of error message associated with the exception
      Since:
      9.1

    • getAction

      public String getAction()

    • setAction

      public void setAction(String isAction)