Package io.electrum.suv.api.models

Class ErrorDetail

java.lang.Object

io.electrum.suv.api.models.ErrorDetail

public class ErrorDetail
extends Object

Represents the reasons an operation has failed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ErrorDetail.ErrorType	The type of error that occurred

Constructor Summary

Constructors

Constructor	Description
ErrorDetail()

Method Summary

Modifier and Type	Method	Description
ErrorDetail	detailMessage(Object detailMessage)
boolean	equals(Object o)
ErrorDetail	errorMessage(String errorMessage)
ErrorDetail	errorType(ErrorDetail.ErrorType errorType)
Object	getDetailMessage()	A free form detailed description of a particular failure condition may optionally be supplied
String	getErrorMessage()	A short description of the error
ErrorDetail.ErrorType	getErrorType()	The type of error that occurred
String	getId()	The randomly generated UUID identifying this errorDetail, as defined for a variant 4 UUID in [RFC 4122](https://tools.ietf.org/html/rfc4122)
String	getOriginalId()	The UUID of the original request message in the case of an error occurring for an advice message
String	getProviderErrorCode()	The response code received from the voucher vendor in response to an operation.
String	getProviderErrorMessage()	The error message received from the voucher vendor in response to an operation.
int	hashCode()
ErrorDetail	id(String id)
ErrorDetail	originalId(String originalId)
ErrorDetail	providerErrorCode(String providerErrorCode)
ErrorDetail	providerErrorMessage(String providerErrorMessage)
void	setDetailMessage(Object detailMessage)
void	setErrorMessage(String errorMessage)
void	setErrorType(ErrorDetail.ErrorType errorType)
void	setId(String id)
void	setOriginalId(String originalId)
void	setProviderErrorCode(String providerErrorCode)
void	setProviderErrorMessage(String providerErrorMessage)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ErrorDetail

public ErrorDetail()

Method Detail

id

public ErrorDetail id(String id)

getId

@NotNull
public String getId()

The randomly generated UUID identifying this errorDetail, as defined for a variant 4 UUID in [RFC 4122](https://tools.ietf.org/html/rfc4122)

Returns:

id

setId

public void setId(String id)

originalId

public ErrorDetail originalId(String originalId)

getOriginalId

public String getOriginalId()

The UUID of the original request message in the case of an error occurring for an advice message

Returns:

originalId

setOriginalId

public void setOriginalId(String originalId)

errorType

public ErrorDetail errorType(ErrorDetail.ErrorType errorType)

getErrorType

@NotNull
public ErrorDetail.ErrorType getErrorType()

The type of error that occurred

Returns:

errorType

setErrorType

public void setErrorType(ErrorDetail.ErrorType errorType)

errorMessage

public ErrorDetail errorMessage(String errorMessage)

getErrorMessage

@NotNull
@Size(min=0,
      max=80)
public String getErrorMessage()

A short description of the error

Returns:

errorMessage

setErrorMessage

public void setErrorMessage(String errorMessage)

providerErrorCode

public ErrorDetail providerErrorCode(String providerErrorCode)

getProviderErrorCode

public String getProviderErrorCode()

The response code received from the voucher vendor in response to an operation.

Returns:

providerErrorCode

setProviderErrorCode

public void setProviderErrorCode(String providerErrorCode)

providerErrorMessage

public ErrorDetail providerErrorMessage(String providerErrorMessage)

getProviderErrorMessage

public String getProviderErrorMessage()

The error message received from the voucher vendor in response to an operation.

Returns:

providerErrorMessage

setProviderErrorMessage

public void setProviderErrorMessage(String providerErrorMessage)

detailMessage

public ErrorDetail detailMessage(Object detailMessage)

getDetailMessage

public Object getDetailMessage()

A free form detailed description of a particular failure condition may optionally be supplied

Returns:

detailMessage

setDetailMessage

public void setDetailMessage(Object detailMessage)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object