Package com.clover.remote.client.messages

Class BaseResponse

java.lang.Object

com.clover.remote.client.messages.BaseResponse

Direct Known Subclasses:

CapturePreAuthResponse, CheckBalanceResponse, CloseoutResponse, CustomActivityResponse, CustomerProvidedDataEvent, DisplayReceiptOptionsResponse, InvalidStateTransitionResponse, ManualRefundResponse, PaymentResponse, PrintJobStatusResponse, ReadCardDataResponse, RefundPaymentResponse, ResetDeviceResponse, RetrieveDeviceStatusResponse, RetrievePaymentResponse, RetrievePendingPaymentsResponse, RetrievePrintersResponse, SignatureResponse, TipAdjustAuthResponse, TipResponse, VaultCardResponse

public class BaseResponse
extends Object

The base for responses

Constructor Summary

Constructors

Constructor	Description
BaseResponse()
BaseResponse(boolean success, ResultCode result)	Constructor

Method Summary

Modifier and Type	Method	Description
String	getMessage()	Get the field value
String	getReason()	Get the field value
ResultCode	getResult()	Get the field value
final boolean	isSuccess()	Get the field value
void	setMessage(String message)	Set the field value
void	setReason(String reason)	Set the field value
void	setResult(ResultCode result)	Set the field value
void	setSuccess(boolean success)	Set the field value

Methods inherited from class java.lang.Object

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

Constructor Details

BaseResponse

public BaseResponse()

BaseResponse

public BaseResponse(boolean success,
 ResultCode result)

Constructor

Parameters:

success - If true then the requested operation succeeded

result - The result of the requested operation

Method Details

setSuccess

public void setSuccess(boolean success)

Set the field value

Parameters:

success - If true then the requested operation succeeded

isSuccess

public final boolean isSuccess()

Get the field value

Returns:

If true then the requested operation succeeded

setResult

public void setResult(ResultCode result)

Set the field value

Parameters:

result - The result of the requested operation

getResult

public ResultCode getResult()

Get the field value

Returns:

The result of the requested operation

setReason

public void setReason(String reason)

Set the field value

Parameters:

reason - Optional information about result.

getReason

public String getReason()

Get the field value

Returns:

Optional information about result.

setMessage

public void setMessage(String message)

Set the field value

Parameters:

message - Detailed information about result.

getMessage

public String getMessage()

Get the field value

Returns:

Detailed information about result.