com.thomsonreuters.upa.valueadd.reactor

Class ReactorErrorInfo

java.lang.Object

com.thomsonreuters.upa.valueadd.reactor.ReactorErrorInfo

public class ReactorErrorInfo
extends java.lang.Object

ErrorInfo is used by various Reactor methods to return error or warning information to the user. If the code is SUCCESS, then there is no error. Otherwise, the user should inspect the code, Error and location.

See Also:

Error

Method Summary

Modifier and Type	Method and Description
void	clear() Clears this object for reuse.
int	code() The ReactorReturnCodes.
com.thomsonreuters.upa.transport.Error	error() If the code() is not SUCCESS, the Error will contain information regarding the error that occurred.
java.lang.String	location() If the code() is not SUCCESS, the location will identify where the error occurred.
java.lang.String	toString() Returns a String representation of the ReactorErrorInfo.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

code

public int code()

The ReactorReturnCodes. If the code is not ReactorReturnCodes.SUCCESS, the user should inspect this code, error and location.

Returns:

ReactorReturnCodes

location

public java.lang.String location()

If the code() is not SUCCESS, the location will identify where the error occurred.

Returns:

A String representing the location where the error occurred

error

public com.thomsonreuters.upa.transport.Error error()

If the code() is not SUCCESS, the Error will contain information regarding the error that occurred.

Returns:

An Error object

toString

public java.lang.String toString()

Returns a String representation of the ReactorErrorInfo.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of the ReactorErrorInfo

clear

public void clear()

Clears this object for reuse.