Thor.API.Exceptions

Class tcBulkException

java.lang.Object

java.lang.Throwable

java.lang.Exception

Thor.API.Exceptions.tcBulkException

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

This exception is raised whenever a bulk operation is called and the operation is only successfull on some of the bulk transactions. If this happens, a tcBulkOperation is raise and the keys that failed are stored in isKeys with their respective error messages in isErrorMessages. In Addition, if the operation returned information back, that information can be set in the using setReturnValue by the API. The caller will need to get the return value and cast it to the respective object based on the information about the API that is called.

Since:

7.2

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String[]	errorCodes
java.lang.String[]	isErrorMessages Corresponding error messages for each of the keys that failed the operation
java.lang.String[]	isKeys Array of keys that failed the operation
java.lang.String	isMessage The message of this exception
java.lang.String[]	isSeverity

Constructor Summary

Constructors

Constructor and Description
tcBulkException() Creates a new tcBulkException object.
tcBulkException(java.lang.String isMessage, java.lang.String[] isKeys, java.lang.String[] isErrorMessages) Creates a new tcBulkException object.
tcBulkException(java.lang.String isMessage, java.lang.String[] isKeys, java.lang.String[] isErrorMessages, java.lang.String[] errorCodes)
tcBulkException(java.lang.String isMessage, java.lang.String[] isKeys, java.lang.String[] isErrorMessages, java.lang.String[] errorCodes, java.lang.String[] severity) Creates a new tcBulkException object.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clone method
java.lang.String[]	getErrorCodes()
java.lang.Object	getReturnValue() Returns the object that needed to be returned by the API when the bulk exception occurred.
void	setReturnValue(java.lang.Object retval) Stores the return value that the API intended to send back when a bulk exception occurred by the failing of some of the transactions

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, 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 message of this exception

isKeys

public java.lang.String[] isKeys

Array of keys that failed the operation

isErrorMessages

public java.lang.String[] isErrorMessages

Corresponding error messages for each of the keys that failed the operation

errorCodes

public java.lang.String[] errorCodes

isSeverity

public java.lang.String[] isSeverity

Constructor Detail

tcBulkException

public tcBulkException()

Creates a new tcBulkException object.

tcBulkException

public tcBulkException(java.lang.String isMessage,
                       java.lang.String[] isKeys,
                       java.lang.String[] isErrorMessages)

Creates a new tcBulkException object.

Parameters:

isMessage - The generic message for this exception

isKeys - array of keys that failed the operation

isErrorMessages - array of messages corresponding to the keys that failed the operation

tcBulkException

public tcBulkException(java.lang.String isMessage,
                       java.lang.String[] isKeys,
                       java.lang.String[] isErrorMessages,
                       java.lang.String[] errorCodes)

tcBulkException

public tcBulkException(java.lang.String isMessage,
                       java.lang.String[] isKeys,
                       java.lang.String[] isErrorMessages,
                       java.lang.String[] errorCodes,
                       java.lang.String[] severity)

Creates a new tcBulkException object.

Parameters:

isMessage - The generic message for this exception

isKeys - array of keys that failed the operation

isErrorMessages - array of messages corresponding to the keys that failed the operation

errorCodes - array of error codes corresponding to the keys that failed the operation

severity - array of severity level corresponding to the keys that failed the operation

Since:

9.1

Method Detail

getErrorCodes

public java.lang.String[] getErrorCodes()

setReturnValue

public void setReturnValue(java.lang.Object retval)

Stores the return value that the API intended to send back when a bulk 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 bulk exception occurred.

Returns:

an Object that need to be casted depending on the return value of the API that caused the bulk exception to happen

Since:

8.0

clone

public java.lang.Object clone()

Clone method

Overrides:

clone in class java.lang.Object

Returns:

the clone of this bulk exception

Throws:

java.lang.Error - Error if any of the components cannot be cloned.