oneapi.model.common

Class RequestError

java.lang.Object

oneapi.model.common.RequestError

All Implemented Interfaces:

Serializable

public class RequestError
extends Object
implements Serializable

contains an error response returned from the OneAPI server

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	POLICYEXCEPTION internally used to indicate the type of exception being stored is a PolicyException
static int	SERVICEEXCEPTION internally used to indicate the type of exception being stored is a ServiceException

Constructor Summary

Constructors

Constructor and Description
RequestError() default constructor
RequestError(int type, int httpResponseCode, String messageId, String clientCorrelator, String text, String... variables) utility constructor to create an RequestError instance with all fields set

Method Summary

Modifier and Type	Method and Description
String	getClientCorrelator() return the clientCorrelator
int	getExceptionType() get the type of the exception
int	getHttpResponseCode() get the HTTP response code
PolicyException	getPolicyException() return the policyException instance
ServiceException	getServiceException() return the serviceException instance
void	setExceptionType(int n) set the type of the exception
void	setHttpResponseCode(int n) set the HTTP response code
void	setPolicyException(PolicyException policyException) set the policyException instance
void	setServiceException(ServiceException serviceException) set the serviceException instance
String	toString() generate a textual representation of the RequestError including all nested elements and classes

Methods inherited from class java.lang.Object

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

Field Detail

SERVICEEXCEPTION

public static final int SERVICEEXCEPTION

internally used to indicate the type of exception being stored is a ServiceException

See Also:

Constant Field Values

POLICYEXCEPTION

public static final int POLICYEXCEPTION

internally used to indicate the type of exception being stored is a PolicyException

See Also:

Constant Field Values

Constructor Detail

RequestError

public RequestError(int type,
                    int httpResponseCode,
                    String messageId,
                    String clientCorrelator,
                    String text,
                    String... variables)

utility constructor to create an RequestError instance with all fields set

RequestError

public RequestError()

default constructor

Method Detail

getClientCorrelator

public String getClientCorrelator()

return the clientCorrelator

getServiceException

public ServiceException getServiceException()

return the serviceException instance

setServiceException

public void setServiceException(ServiceException serviceException)

set the serviceException instance

getExceptionType

public int getExceptionType()

get the type of the exception

getHttpResponseCode

public int getHttpResponseCode()

get the HTTP response code

getPolicyException

public PolicyException getPolicyException()

return the policyException instance

setPolicyException

public void setPolicyException(PolicyException policyException)

set the policyException instance

setExceptionType

public void setExceptionType(int n)

set the type of the exception

setHttpResponseCode

public void setHttpResponseCode(int n)

set the HTTP response code

toString

public String toString()

generate a textual representation of the RequestError including all nested elements and classes

Overrides:

toString in class Object