Package com.broadleafcommerce.paypal.micro.domain.api

Class PayPalRefundRequest

java.lang.Object

com.broadleafcommerce.paypal.micro.domain.api.AbstractPayPalRequest<Refund>

com.broadleafcommerce.paypal.micro.domain.api.PayPalRefundRequest

All Implemented Interfaces:

PayPalRequest

public class PayPalRefundRequest
extends AbstractPayPalRequest<Refund>

Represents a refund request. To partially refund an order, specify RefundRequest.setAmount(Money), otherwise the refund request may be empty (but not null).

Constructor Summary

Constructors

Constructor	Description
PayPalRefundRequest(PayPalApiProvider apiProvider, com.broadleafcommerce.paymentgateway.domain.PaymentRequest paymentRequest, RefundRequest refundRequest, String captureId)

Method Summary

Modifier and Type	Method	Description
protected AbstractPayPalResponse<Refund>	executeInternal(String applicationId, String tenantId)	Executes the configured request using the PayPalApiProvider.
protected String	getCaptureId()
protected RefundRequest	getRefundRequest()
protected boolean	isValidInternal()	Implementation specific determination of whether the request can be executed.

Methods inherited from class com.broadleafcommerce.paypal.micro.domain.api.AbstractPayPalRequest

buildIdempotencyKey, configureRequestHeaders, execute, getPaymentRequest, getPayPalApiProvider, isExecuted, isValid, preferMinimalHeader, preferRepresentationHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

PayPalRefundRequest

public PayPalRefundRequest(PayPalApiProvider apiProvider,
                           com.broadleafcommerce.paymentgateway.domain.PaymentRequest paymentRequest,
                           RefundRequest refundRequest,
                           String captureId)

Method Detail

executeInternal

protected AbstractPayPalResponse<Refund> executeInternal(@Nullable
                                                         String applicationId,
                                                         @Nullable
                                                         String tenantId)
                                                  throws PayPalProviderApiException

Description copied from class: AbstractPayPalRequest

Executes the configured request using the PayPalApiProvider.

Specified by:

executeInternal in class AbstractPayPalRequest<Refund>

Parameters:

applicationId - the application ID

tenantId - the tenant ID

Returns:

The response from PayPal

Throws:

PayPalProviderApiException - Thrown if the request execution fails.

isValidInternal

protected boolean isValidInternal()

Description copied from class: AbstractPayPalRequest

Implementation specific determination of whether the request can be executed.

Specified by:

isValidInternal in class AbstractPayPalRequest<Refund>

Returns:

Whether the request can be executed or is in an erroneous state.

getCaptureId

protected String getCaptureId()

getRefundRequest

protected RefundRequest getRefundRequest()