com.adobe.cq.commerce.api

Interface PaymentMethod

public interface PaymentMethod

Interface that describes a payment method.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Return a shopper-oriented description.
java.lang.String	getImageUrl(java.lang.String selector) Return a shopper-oriented image identifying the payment method.
java.lang.String	getPath() Get the path of the payment method if represented in the repository.
java.lang.String	getPredicate() Return the name of a predicate which can be used to identify this payment method's properties within an order.
<T> T	getProperty(java.lang.String name, java.lang.Class<T> type) Fetch implementation-defined properties from a payment method.
java.lang.String	getRedirectUrl() Return a URL to redirect to for data collection, or null if no redirect (or no data collection) is required.
java.lang.String	getTitle() Return a shopper-oriented title.
java.lang.String	getUIPath() Return a path to any additional content to be displayed (such as form fields to collect data relevant to the payment, etc.) Return null if data is not collected through CQ.

Method Detail

getPath

java.lang.String getPath()

Get the path of the payment method if represented in the repository. Otherwise, an ID uniquely identifying the payment method to the external commerce engine.

Returns:

the path or the ID of payment method

getPredicate

java.lang.String getPredicate()

Return the name of a predicate which can be used to identify this payment method's properties within an order.

Returns:

getTitle

java.lang.String getTitle()

Return a shopper-oriented title. (Any author-oriented titles/messages required can be returned via getProperty(java.lang.String, java.lang.Class<T>).)

Returns:

getDescription

java.lang.String getDescription()

Return a shopper-oriented description. (Any author-oriented titles/messages required can be returned via getProperty(java.lang.String, java.lang.Class<T>).)

Returns:

getImageUrl

java.lang.String getImageUrl(java.lang.String selector)

Return a shopper-oriented image identifying the payment method.

Parameters:

selector - An implementation-defined selector for image processing/selection (such as a sizing parameter, image-type, etc.)

Returns:

getUIPath

java.lang.String getUIPath()

Return a path to any additional content to be displayed (such as form fields to collect data relevant to the payment, etc.) Return null if data is not collected through CQ.

Returns:

getRedirectUrl

java.lang.String getRedirectUrl()

Return a URL to redirect to for data collection, or null if no redirect (or no data collection) is required.

Returns:

getProperty

<T> T getProperty(java.lang.String name,
                  java.lang.Class<T> type)

Fetch implementation-defined properties from a payment method.

Parameters:

name - The property name

type - The type the property value should be converted to

Returns: