com.clover.remote.client

Class DefaultCloverConnectorListener

java.lang.Object

com.clover.remote.client.DefaultCloverConnectorListener

All Implemented Interfaces:

ICloverConnectorListener

public abstract class DefaultCloverConnectorListener
extends java.lang.Object
implements ICloverConnectorListener

Field Summary

Fields

Modifier and Type	Field and Description
protected ICloverConnector	cloverConnector
protected MerchantInfo	merchantInfo

Constructor Summary

Constructors

Constructor and Description
DefaultCloverConnectorListener(ICloverConnector cloverConnector)

Method Summary

Modifier and Type	Method and Description
boolean	isReady()
void	onAuthResponse(AuthResponse response) Called in response to an auth request
void	onCapturePreAuthResponse(CapturePreAuthResponse response) Called in response to a capture of a pre auth payment
void	onCheckBalanceResponse(CheckBalanceResponse response) Called in response to a CheckBalanceRequest
void	onCloseoutResponse(CloseoutResponse response) Called in response to a closeout being processed
void	onCustomActivityResponse(CustomActivityResponse response) Called when a custom activity finishes
void	onCustomerProvidedData(CustomerProvidedDataEvent event) Called when customer information is provided from a loyalty service.
void	onDeviceActivityEnd(CloverDeviceEvent deviceEvent) Called when a Clover device activity ends.
void	onDeviceActivityStart(CloverDeviceEvent deviceEvent) Called when a Clover device activity starts.
void	onDeviceConnected() Called when the Clover device is connected, but not ready to communicate
void	onDeviceDisconnected() Called when the Clover device is disconnected
void	onDeviceError(CloverDeviceErrorEvent deviceErrorEvent) Called when a Clover device error event is encountered
void	onDeviceReady(MerchantInfo merchantInfo) Called when the Clover device is ready to communicate
void	onDisplayReceiptOptionsResponse(DisplayReceiptOptionsResponse response) Called in response to a DisplayReceiptOptionsRequest
void	onIncrementPreAuthResponse(IncrementPreauthResponse response) Called in response to an `incrementPreAuth()` call on the CloverConnector.
void	onInvalidStateTransitionResponse(InvalidStateTransitionResponse response) Called in response to a request that results in an invalid kiosk flow transition
void	onManualRefundResponse(ManualRefundResponse response) Called in response to a manual refund request
void	onMessageFromActivity(MessageFromActivity message) Called when a message is sent from a custom activity
void	onPreAuthResponse(PreAuthResponse response) Called in response to a pre auth request
void	onPrintJobStatusResponse(PrintJobStatusResponse response) Called to update the status of a print job
void	onPrintManualRefundDeclineReceipt(PrintManualRefundDeclineReceiptMessage pcdrm) Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a declined ManualRefund
void	onPrintManualRefundReceipt(PrintManualRefundReceiptMessage pcm) Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a ManualRefund
void	onPrintPaymentDeclineReceipt(PrintPaymentDeclineReceiptMessage ppdrm) Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a declined payment
void	onPrintPaymentMerchantCopyReceipt(PrintPaymentMerchantCopyReceiptMessage ppmcrm) Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a merchant copy of a payment receipt
void	onPrintPaymentReceipt(PrintPaymentReceiptMessage pprm) Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a payment
void	onPrintRefundPaymentReceipt(PrintRefundPaymentReceiptMessage pprrm) Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a payment refund
void	onReadCardDataResponse(ReadCardDataResponse response) Called in response to a readCardData(...) request.
void	onRefundPaymentResponse(RefundPaymentResponse response) Called in response to a refund payment request
void	onRequestSignatureResponse(SignatureResponse response) Called in response to a RequestSignatureRequest
void	onRequestTipResponse(TipResponse response) Called in response to a TipRequest
void	onResetDeviceResponse(ResetDeviceResponse response) Called in response to a ResetDevice request
void	onRetrieveDeviceStatusResponse(RetrieveDeviceStatusResponse response) Called in response to a RetrieveDeviceState request
void	onRetrievePaymentResponse(RetrievePaymentResponse response) Called in response to a RetrievePaymentRequest
void	onRetrievePendingPaymentsResponse(RetrievePendingPaymentsResponse retrievePendingPaymentResponse) Called in response to a retrievePendingPayment(...) request.
void	onRetrievePrintersResponse(RetrievePrintersResponse response) Called in response to a retrievePrinters() request
void	onSaleResponse(SaleResponse response) Called in response to a sale request
void	onTipAdded(com.clover.remote.message.TipAddedMessage message) Called when a customer selects a tip amount on the Clover device screen
void	onTipAdjustAuthResponse(TipAdjustAuthResponse response) Called in response to a tip adjust of an auth payment
void	onVaultCardResponse(VaultCardResponse response) Called in response to a vault card request
void	onVerifySignatureRequest(VerifySignatureRequest request) Called when the Clover device requires a signature to be verified
void	onVoidPaymentRefundResponse(VoidPaymentRefundResponse response) Called in response to a void payment refund request
void	onVoidPaymentResponse(VoidPaymentResponse response) Called in response to a void payment request

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.clover.remote.client.ICloverConnectorListener

onConfirmPaymentRequest

Field Detail

merchantInfo

protected MerchantInfo merchantInfo

cloverConnector

protected ICloverConnector cloverConnector

Constructor Detail

DefaultCloverConnectorListener

public DefaultCloverConnectorListener(ICloverConnector cloverConnector)

Method Detail

isReady

public boolean isReady()

onDeviceDisconnected

public void onDeviceDisconnected()

Description copied from interface: ICloverConnectorListener

Called when the Clover device is disconnected

Specified by:

onDeviceDisconnected in interface ICloverConnectorListener

onDeviceConnected

public void onDeviceConnected()

Description copied from interface: ICloverConnectorListener

Called when the Clover device is connected, but not ready to communicate

Specified by:

onDeviceConnected in interface ICloverConnectorListener

onDeviceReady

public void onDeviceReady(MerchantInfo merchantInfo)

Description copied from interface: ICloverConnectorListener

Called when the Clover device is ready to communicate

Specified by:

onDeviceReady in interface ICloverConnectorListener

Parameters:

merchantInfo - The merchant info for the device

onDeviceActivityStart

public void onDeviceActivityStart(CloverDeviceEvent deviceEvent)

Description copied from interface: ICloverConnectorListener

Called when a Clover device activity starts.

Specified by:

onDeviceActivityStart in interface ICloverConnectorListener

Parameters:

deviceEvent - The device event.

onDeviceActivityEnd

public void onDeviceActivityEnd(CloverDeviceEvent deviceEvent)

Description copied from interface: ICloverConnectorListener

Called when a Clover device activity ends.

Specified by:

onDeviceActivityEnd in interface ICloverConnectorListener

Parameters:

deviceEvent - The device event.

onDeviceError

public void onDeviceError(CloverDeviceErrorEvent deviceErrorEvent)

Description copied from interface: ICloverConnectorListener

Called when a Clover device error event is encountered

Specified by:

onDeviceError in interface ICloverConnectorListener

Parameters:

deviceErrorEvent - The device error event.

onAuthResponse

public void onAuthResponse(AuthResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to an auth request

Specified by:

onAuthResponse in interface ICloverConnectorListener

Parameters:

response - The response

onTipAdjustAuthResponse

public void onTipAdjustAuthResponse(TipAdjustAuthResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a tip adjust of an auth payment

Specified by:

onTipAdjustAuthResponse in interface ICloverConnectorListener

Parameters:

response - The response

onCapturePreAuthResponse

public void onCapturePreAuthResponse(CapturePreAuthResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a capture of a pre auth payment

Specified by:

onCapturePreAuthResponse in interface ICloverConnectorListener

Parameters:

response - The response

onIncrementPreAuthResponse

public void onIncrementPreAuthResponse(IncrementPreauthResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to an `incrementPreAuth()` call on the CloverConnector. Returns the incremented pre-auth, if successful.

Specified by:

onIncrementPreAuthResponse in interface ICloverConnectorListener

onVerifySignatureRequest

public void onVerifySignatureRequest(VerifySignatureRequest request)

Description copied from interface: ICloverConnectorListener

Called when the Clover device requires a signature to be verified

Specified by:

onVerifySignatureRequest in interface ICloverConnectorListener

Parameters:

request - The request

onCloseoutResponse

public void onCloseoutResponse(CloseoutResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a closeout being processed

Specified by:

onCloseoutResponse in interface ICloverConnectorListener

Parameters:

response - The response

onSaleResponse

public void onSaleResponse(SaleResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a sale request

Specified by:

onSaleResponse in interface ICloverConnectorListener

Parameters:

response - The response

onPreAuthResponse

public void onPreAuthResponse(PreAuthResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a pre auth request

Specified by:

onPreAuthResponse in interface ICloverConnectorListener

Parameters:

response - The response

onManualRefundResponse

public void onManualRefundResponse(ManualRefundResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a manual refund request

Specified by:

onManualRefundResponse in interface ICloverConnectorListener

Parameters:

response - The response

onRefundPaymentResponse

public void onRefundPaymentResponse(RefundPaymentResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a refund payment request

Specified by:

onRefundPaymentResponse in interface ICloverConnectorListener

Parameters:

response - The response

onTipAdded

public void onTipAdded(com.clover.remote.message.TipAddedMessage message)

Description copied from interface: ICloverConnectorListener

Called when a customer selects a tip amount on the Clover device screen

Specified by:

onTipAdded in interface ICloverConnectorListener

Parameters:

message - The message

onVoidPaymentResponse

public void onVoidPaymentResponse(VoidPaymentResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a void payment request

Specified by:

onVoidPaymentResponse in interface ICloverConnectorListener

Parameters:

response - The response

onVoidPaymentRefundResponse

public void onVoidPaymentRefundResponse(VoidPaymentRefundResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a void payment refund request

Specified by:

onVoidPaymentRefundResponse in interface ICloverConnectorListener

Parameters:

response - The response

onVaultCardResponse

public void onVaultCardResponse(VaultCardResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a vault card request

Specified by:

onVaultCardResponse in interface ICloverConnectorListener

Parameters:

response - The response

onPrintManualRefundReceipt

public void onPrintManualRefundReceipt(PrintManualRefundReceiptMessage pcm)

Description copied from interface: ICloverConnectorListener

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a ManualRefund

Specified by:

onPrintManualRefundReceipt in interface ICloverConnectorListener

Parameters:

pcm - The message

onPrintManualRefundDeclineReceipt

public void onPrintManualRefundDeclineReceipt(PrintManualRefundDeclineReceiptMessage pcdrm)

Description copied from interface: ICloverConnectorListener

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a declined ManualRefund

Specified by:

onPrintManualRefundDeclineReceipt in interface ICloverConnectorListener

Parameters:

pcdrm - The message

onPrintPaymentReceipt

public void onPrintPaymentReceipt(PrintPaymentReceiptMessage pprm)

Description copied from interface: ICloverConnectorListener

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a payment

Specified by:

onPrintPaymentReceipt in interface ICloverConnectorListener

Parameters:

pprm - The message

onPrintPaymentDeclineReceipt

public void onPrintPaymentDeclineReceipt(PrintPaymentDeclineReceiptMessage ppdrm)

Description copied from interface: ICloverConnectorListener

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a declined payment

Specified by:

onPrintPaymentDeclineReceipt in interface ICloverConnectorListener

Parameters:

ppdrm - The message

onPrintPaymentMerchantCopyReceipt

public void onPrintPaymentMerchantCopyReceipt(PrintPaymentMerchantCopyReceiptMessage ppmcrm)

Description copied from interface: ICloverConnectorListener

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a merchant copy of a payment receipt

Specified by:

onPrintPaymentMerchantCopyReceipt in interface ICloverConnectorListener

Parameters:

ppmcrm - The message

onPrintRefundPaymentReceipt

public void onPrintRefundPaymentReceipt(PrintRefundPaymentReceiptMessage pprrm)

Description copied from interface: ICloverConnectorListener

Will only be called if disablePrinting = true on the Sale, Auth, PreAuth or ManualRefund Request Called when a user requests to print a receipt for a payment refund

Specified by:

onPrintRefundPaymentReceipt in interface ICloverConnectorListener

Parameters:

pprrm - The message

onRetrievePendingPaymentsResponse

public void onRetrievePendingPaymentsResponse(RetrievePendingPaymentsResponse retrievePendingPaymentResponse)

Description copied from interface: ICloverConnectorListener

Called in response to a retrievePendingPayment(...) request.

Specified by:

onRetrievePendingPaymentsResponse in interface ICloverConnectorListener

Parameters:

retrievePendingPaymentResponse - The response

onReadCardDataResponse

public void onReadCardDataResponse(ReadCardDataResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a readCardData(...) request.

Specified by:

onReadCardDataResponse in interface ICloverConnectorListener

Parameters:

response - The response

onMessageFromActivity

public void onMessageFromActivity(MessageFromActivity message)

Description copied from interface: ICloverConnectorListener

Called when a message is sent from a custom activity

Specified by:

onMessageFromActivity in interface ICloverConnectorListener

Parameters:

message - The message

onCustomActivityResponse

public void onCustomActivityResponse(CustomActivityResponse response)

Description copied from interface: ICloverConnectorListener

Called when a custom activity finishes

Specified by:

onCustomActivityResponse in interface ICloverConnectorListener

Parameters:

response - The response

onRetrieveDeviceStatusResponse

public void onRetrieveDeviceStatusResponse(RetrieveDeviceStatusResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a RetrieveDeviceState request

Specified by:

onRetrieveDeviceStatusResponse in interface ICloverConnectorListener

Parameters:

response - The response

onInvalidStateTransitionResponse

public void onInvalidStateTransitionResponse(InvalidStateTransitionResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a request that results in an invalid kiosk flow transition

Specified by:

onInvalidStateTransitionResponse in interface ICloverConnectorListener

Parameters:

response - The response

onResetDeviceResponse

public void onResetDeviceResponse(ResetDeviceResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a ResetDevice request

Specified by:

onResetDeviceResponse in interface ICloverConnectorListener

Parameters:

response - The response

onRetrievePaymentResponse

public void onRetrievePaymentResponse(RetrievePaymentResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a RetrievePaymentRequest

Specified by:

onRetrievePaymentResponse in interface ICloverConnectorListener

Parameters:

response - The response

onRetrievePrintersResponse

public void onRetrievePrintersResponse(RetrievePrintersResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a retrievePrinters() request

Specified by:

onRetrievePrintersResponse in interface ICloverConnectorListener

Parameters:

response - Response object containing an array of the printers being passed back

onPrintJobStatusResponse

public void onPrintJobStatusResponse(PrintJobStatusResponse response)

Description copied from interface: ICloverConnectorListener

Called to update the status of a print job

Specified by:

onPrintJobStatusResponse in interface ICloverConnectorListener

Parameters:

response - The response contains the print job identifier and that job's status

onCustomerProvidedData

public void onCustomerProvidedData(CustomerProvidedDataEvent event)

Description copied from interface: ICloverConnectorListener

Called when customer information is provided from a loyalty service.

Specified by:

onCustomerProvidedData in interface ICloverConnectorListener

Parameters:

event - The event

onDisplayReceiptOptionsResponse

public void onDisplayReceiptOptionsResponse(DisplayReceiptOptionsResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a DisplayReceiptOptionsRequest

Specified by:

onDisplayReceiptOptionsResponse in interface ICloverConnectorListener

onCheckBalanceResponse

public void onCheckBalanceResponse(CheckBalanceResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a CheckBalanceRequest

Specified by:

onCheckBalanceResponse in interface ICloverConnectorListener

onRequestSignatureResponse

public void onRequestSignatureResponse(SignatureResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a RequestSignatureRequest

Specified by:

onRequestSignatureResponse in interface ICloverConnectorListener

onRequestTipResponse

public void onRequestTipResponse(TipResponse response)

Description copied from interface: ICloverConnectorListener

Called in response to a TipRequest

Specified by:

onRequestTipResponse in interface ICloverConnectorListener