com.simplify.payments.exception

Class InvalidRequestException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.simplify.payments.exception.ApiException

com.simplify.payments.exception.InvalidRequestException

All Implemented Interfaces:

java.io.Serializable

public class InvalidRequestException
extends ApiException

Thrown to indicate that an error occured processing an API request.

See Also:

ApiException, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	InvalidRequestException.FieldError Class representing a single error on a field in a request sent to the API.

Constructor Summary

Constructors

Constructor and Description
InvalidRequestException() Constructs an InvalidRequestException with no detail message.
InvalidRequestException(int status, java.util.Map<? extends java.lang.String,? extends java.lang.Object> errorData) Constructs an InvalidRequestException with the specified status and error data.
InvalidRequestException(java.lang.String s) Constructs an InvalidRequestException with the specified detail message.
InvalidRequestException(java.lang.String s, java.lang.Throwable cause) Constructs an InvalidRequestException with the specified detail message and cause.
InvalidRequestException(java.lang.Throwable cause) Constructs an InvalidRequestException with the specified cause.

Method Summary

Modifier and Type	Method and Description
java.lang.String	describe() Returns a string describing the exception.
java.util.List<InvalidRequestException.FieldError>	getFieldErrors() Returns the list of field errors for this exception.
boolean	hasFieldErrors() Returns a boolean indicating if this exception contains field errors.

Methods inherited from class com.simplify.payments.exception.ApiException

getErrorCode, getErrorData, getMessage, getReference, getStatus

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

InvalidRequestException

public InvalidRequestException()

Constructs an InvalidRequestException with no detail message.

InvalidRequestException

public InvalidRequestException(java.lang.String s)

Constructs an InvalidRequestException with the specified detail message.

Parameters:

s - the detail message.

InvalidRequestException

public InvalidRequestException(java.lang.String s,
                               java.lang.Throwable cause)

Constructs an InvalidRequestException with the specified detail message and cause.

Parameters:

s - the detail message.

cause - the detail message.

InvalidRequestException

public InvalidRequestException(java.lang.Throwable cause)

Constructs an InvalidRequestException with the specified cause.

Parameters:

cause - the detail message.

InvalidRequestException

public InvalidRequestException(int status,
                               java.util.Map<? extends java.lang.String,? extends java.lang.Object> errorData)

Constructs an InvalidRequestException with the specified status and error data.

Parameters:

status - the HTTP status code

errorData - a map representing the error details returned by the API. The map is expected to contain String value for the key "reference" and a map containing the detailed error data for the key "key". This map in turn is expected to contain String values for the keys "code" and "message" and a list for the key "fieldErrors" with each entry containing error information for a particular field.

See Also:

ApiException, InvalidRequestException.FieldError

Method Detail

hasFieldErrors

public boolean hasFieldErrors()

Returns a boolean indicating if this exception contains field errors.

Returns:

a boolean indicating if this exception contains field errors.

getFieldErrors

public java.util.List<InvalidRequestException.FieldError> getFieldErrors()

Returns the list of field errors for this exception.

Returns:

a list of FieldError objects (may be empty).

See Also:

InvalidRequestException.FieldError

describe

public java.lang.String describe()

Returns a string describing the exception.

Overrides:

describe in class ApiException

Returns:

a string describing the exception.