com.liferay.commerce.payment.engine

Interface CommercePaymentEngine

public interface CommercePaymentEngine

Method Summary

Modifier and Type	Method and Description
CommercePaymentResult	cancelPayment(long commerceOrderId, java.lang.String transactionId, javax.servlet.http.HttpServletRequest httpServletRequest)
CommercePaymentResult	capturePayment(long commerceOrderId, java.lang.String transactionId, javax.servlet.http.HttpServletRequest httpServletRequest)
CommercePaymentResult	completePayment(long commerceOrderId, java.lang.String transactionId, javax.servlet.http.HttpServletRequest httpServletRequest)
java.lang.String	getCommerceOrderPaymentMethodName(CommerceOrder commerceOrder, javax.servlet.http.HttpServletRequest httpServletRequest, java.util.Locale locale)
int	getCommercePaymentMethodGroupRelsCount(long groupId)
int	getCommercePaymentMethodType(long commerceOrderId)
java.util.List<CommercePaymentMethod>	getEnabledCommercePaymentMethodsForOrder(long groupId, long commerceOrderId)
java.lang.String	getPaymentMethodImageURL(long groupId, java.lang.String paymentMethodKey, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
java.lang.String	getPaymentMethodName(java.lang.String paymentMethodKey, java.util.Locale locale)
CommercePaymentResult	partiallyRefundPayment(long commerceOrderId, java.lang.String transactionId, javax.servlet.http.HttpServletRequest httpServletRequest)
CommercePaymentResult	postProcessPayment(long commerceOrderId, java.lang.String transactionId, javax.servlet.http.HttpServletRequest httpServletRequest)
CommercePaymentResult	processPayment(long commerceOrderId, java.lang.String nextUrl, javax.servlet.http.HttpServletRequest httpServletRequest)
CommercePaymentResult	refundPayment(long commerceOrderId, java.lang.String transactionId, javax.servlet.http.HttpServletRequest httpServletRequest)
CommerceOrder	updateOrderPaymentStatus(long commerceOrderId, int paymentStatus, java.lang.String transactionId, java.lang.String result)
CommercePaymentResult	voidTransaction(long commerceOrderId, java.lang.String transactionId, javax.servlet.http.HttpServletRequest httpServletRequest)

Method Detail

cancelPayment

CommercePaymentResult cancelPayment(long commerceOrderId,
                                    java.lang.String transactionId,
                                    javax.servlet.http.HttpServletRequest httpServletRequest)
                             throws java.lang.Exception

Throws:

java.lang.Exception

capturePayment

CommercePaymentResult capturePayment(long commerceOrderId,
                                     java.lang.String transactionId,
                                     javax.servlet.http.HttpServletRequest httpServletRequest)
                              throws java.lang.Exception

Throws:

java.lang.Exception

completePayment

CommercePaymentResult completePayment(long commerceOrderId,
                                      java.lang.String transactionId,
                                      javax.servlet.http.HttpServletRequest httpServletRequest)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getCommerceOrderPaymentMethodName

java.lang.String getCommerceOrderPaymentMethodName(CommerceOrder commerceOrder,
                                                   javax.servlet.http.HttpServletRequest httpServletRequest,
                                                   java.util.Locale locale)
                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommercePaymentMethodGroupRelsCount

int getCommercePaymentMethodGroupRelsCount(long groupId)

getCommercePaymentMethodType

int getCommercePaymentMethodType(long commerceOrderId)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getEnabledCommercePaymentMethodsForOrder

java.util.List<CommercePaymentMethod> getEnabledCommercePaymentMethodsForOrder(long groupId,
                                                                               long commerceOrderId)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPaymentMethodImageURL

java.lang.String getPaymentMethodImageURL(long groupId,
                                          java.lang.String paymentMethodKey,
                                          com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPaymentMethodName

java.lang.String getPaymentMethodName(java.lang.String paymentMethodKey,
                                      java.util.Locale locale)

partiallyRefundPayment

CommercePaymentResult partiallyRefundPayment(long commerceOrderId,
                                             java.lang.String transactionId,
                                             javax.servlet.http.HttpServletRequest httpServletRequest)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

postProcessPayment

CommercePaymentResult postProcessPayment(long commerceOrderId,
                                         java.lang.String transactionId,
                                         javax.servlet.http.HttpServletRequest httpServletRequest)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

processPayment

CommercePaymentResult processPayment(long commerceOrderId,
                                     java.lang.String nextUrl,
                                     javax.servlet.http.HttpServletRequest httpServletRequest)
                              throws java.lang.Exception

Throws:

java.lang.Exception

refundPayment

CommercePaymentResult refundPayment(long commerceOrderId,
                                    java.lang.String transactionId,
                                    javax.servlet.http.HttpServletRequest httpServletRequest)
                             throws java.lang.Exception

Throws:

java.lang.Exception

updateOrderPaymentStatus

CommerceOrder updateOrderPaymentStatus(long commerceOrderId,
                                       int paymentStatus,
                                       java.lang.String transactionId,
                                       java.lang.String result)
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

voidTransaction

CommercePaymentResult voidTransaction(long commerceOrderId,
                                      java.lang.String transactionId,
                                      javax.servlet.http.HttpServletRequest httpServletRequest)
                               throws java.lang.Exception

Throws:

java.lang.Exception