org.broadleafcommerce.common.payment.service

Interface CurrentOrderPaymentRequestService

All Known Implementing Classes:

DefaultCurrentOrderPaymentRequestService

public interface CurrentOrderPaymentRequestService

Simple interface for returning a PaymentRequestDTO based on the current order in the system (like something on threadlocal).

Author:

Phillip Verheyden (phillipuniverse)

Method Summary

Modifier and Type	Method and Description
void	addOrderAttributeToCurrentOrder(String orderAttributeKey, String orderAttributeValue) adds a concept of an "order attribute" to the current order in the system
void	addOrderAttributeToOrder(Long orderId, String orderAttributeKey, String orderAttributeValue) adds a concept of an "order attribute" to an order in the system based on ID.
PaymentRequestDTO	getPaymentRequestFromCurrentOrder() Returns a PaymentRequestDTO based on all the information from the current order in the system, like one on threadlocal
String	retrieveOrderAttributeFromCurrentOrder(String orderAttributeKey) retrieve an "order attribute" value on the current order in the system
String	retrieveOrderAttributeFromOrder(Long orderId, String orderAttributeKey) retrieve an "order attribute" value based on the order id in the system

Method Detail

getPaymentRequestFromCurrentOrder

PaymentRequestDTO getPaymentRequestFromCurrentOrder()

Returns a PaymentRequestDTO based on all the information from the current order in the system, like one on threadlocal

addOrderAttributeToCurrentOrder

void addOrderAttributeToCurrentOrder(String orderAttributeKey,
                                     String orderAttributeValue)
                              throws PaymentException

adds a concept of an "order attribute" to the current order in the system

Parameters:

orderAttributeKey -

orderAttributeValue -

Throws:

PaymentException

addOrderAttributeToOrder

void addOrderAttributeToOrder(Long orderId,
                              String orderAttributeKey,
                              String orderAttributeValue)
                       throws PaymentException

adds a concept of an "order attribute" to an order in the system based on ID.

Parameters:

orderAttributeKey -

orderAttributeValue -

Throws:

PaymentException

retrieveOrderAttributeFromCurrentOrder

String retrieveOrderAttributeFromCurrentOrder(String orderAttributeKey)

retrieve an "order attribute" value on the current order in the system

Parameters:

orderAttributeKey -

Returns:

retrieveOrderAttributeFromOrder

String retrieveOrderAttributeFromOrder(Long orderId,
                                       String orderAttributeKey)

retrieve an "order attribute" value based on the order id in the system

Parameters:

orderId -

orderAttributeKey -

Returns: