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

Class PayPalCaptureOrderRequest

java.lang.Object

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

com.broadleafcommerce.paypal.micro.domain.api.PayPalCaptureOrderRequest

All Implemented Interfaces:

PayPalRequest

public class PayPalCaptureOrderRequest
extends AbstractPayPalRequest<Order>

Request object used to capture an order immediately. To auth the order immediately but capture it later, use PayPalCaptureAuthRequest.

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

Constructor	Description
PayPalCaptureOrderRequest(PayPalApiProvider apiProvider, com.broadleafcommerce.paymentgateway.domain.PaymentRequest paymentRequest, String orderId)
PayPalCaptureOrderRequest(PayPalApiProvider apiProvider, com.broadleafcommerce.paymentgateway.domain.PaymentRequest paymentRequest, String orderId, OrderCaptureRequest captureRequest)

Method Summary

Modifier and Type	Method	Description
protected AbstractPayPalResponse<Order>	executeInternal(String applicationId, String tenantId)	Executes the configured request using the PayPalApiProvider.
protected OrderCaptureRequest	getCaptureRequest()
protected String	getOrderId()
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

PayPalCaptureOrderRequest

public PayPalCaptureOrderRequest(PayPalApiProvider apiProvider,
                                 com.broadleafcommerce.paymentgateway.domain.PaymentRequest paymentRequest,
                                 String orderId)

PayPalCaptureOrderRequest

public PayPalCaptureOrderRequest(PayPalApiProvider apiProvider,
                                 com.broadleafcommerce.paymentgateway.domain.PaymentRequest paymentRequest,
                                 String orderId,
                                 @Nullable
                                 OrderCaptureRequest captureRequest)

Method Detail

executeInternal

protected AbstractPayPalResponse<Order> 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<Order>

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<Order>

Returns:

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

getOrderId

protected String getOrderId()

getCaptureRequest

@Nullable
protected OrderCaptureRequest getCaptureRequest()