com.adobe.cq.commerce.api

Interface CommerceService

All Known Implementing Classes:

AbstractJcrCommerceService

public interface CommerceService

The CommerceService is the root of the Commerce API; other classes are fetched through it.

In the case of external commerce providers, the CommerceService handles basic connectivity to the commerce server, including command translation and issuance to the server's service API.

Individual resources in the repository can nominate a particular implementation of the CommerceService through their CommerceConstants.PN_COMMERCE_PROVIDER properties.

A CommerceService is then normally fetched using the adapter pattern: resource.adaptTo(CommerceService.class)

Method Summary

Modifier and Type	Method and Description
void	catalogRolloutHook(Page blueprint, Page catalog) Called during catalog creation or update to allow the commerce implementation to perform implementation-specific actions.
java.util.List<Promotion>	getAvailablePromotions(ResourceResolver resourceResolver) Get the list of available promotions.
java.util.Map<java.lang.String,java.lang.Object>	getContext() Get the context or an empty map if no context has been set before via setContext(Map).
java.util.List<java.lang.String>	getCountries() Deprecated. since 6.1, use CommerceSession.getAvailableCountries()
java.util.List<java.lang.String>	getCreditCardTypes() Deprecated. since 6.1, use CommerceSession.getAvailablePaymentMethods()
java.util.List<java.lang.String>	getOrderPredicates() Get the list of predicates for selecting placed orders.
Product	getProduct(java.lang.String path) Get the product by path.
ProductCollection	getProductCollection(java.lang.String path) Get the product collection by path (or ID for external product collections).
Promotion	getPromotion(java.lang.String path) Get the voucher by path (or ID for external promotions).
java.lang.String	getServer() Get the configured commerce server endpoint.
Voucher	getVoucher(java.lang.String path) Get the voucher by path (or ID for external vouchers).
boolean	isActivated(Product product) Check for public availability of a product.
boolean	isAvailable(java.lang.String serviceType) Test whether the commerce service (especially ones that rely on 3rd party services) is currently available.
CommerceSession	login(SlingHttpServletRequest request, SlingHttpServletResponse response) Returns a CommerceSession for the user identified by the given request.
void	productRolloutHook(Product productData, Page productPage, Product productReference) Called during catalog creation or update to allow the commerce implementation to perform implementation-specific actions.
CommerceResult	search(CommerceQuery query) Perform a search.
void	sectionRolloutHook(Page blueprint, Page section) Called during catalog creation or update to allow the commerce implementation to perform implementation-specific actions.
void	setContext(java.util.Map<java.lang.String,java.lang.Object> context) Set a context for this service instance and any session retrieved from it.

Method Detail

login

CommerceSession login(SlingHttpServletRequest request,
                      SlingHttpServletResponse response)
               throws CommerceException

Returns a CommerceSession for the user identified by the given request.

Parameters:

request - The scope's request.

response - The scope's response.

Returns:

A CommerceSession for the user.

Throws:

CommerceException

isAvailable

boolean isAvailable(java.lang.String serviceType)

Test whether the commerce service (especially ones that rely on 3rd party services) is currently available.

Parameters:

serviceType - The type of the service that is tested to be available (e.g. payment, fulfillment etc.).

Returns:

true if available

See Also:

CommerceConstants.SERVICE_COMMERCE

getServer

java.lang.String getServer()

Get the configured commerce server endpoint.

Returns:

setContext

void setContext(java.util.Map<java.lang.String,java.lang.Object> context)

Set a context for this service instance and any session retrieved from it. Service and session implementations may send the context with requests to remote commerce providers.

Note that the context is not persisted across requests and needs to be set again when creating a new service instance.

Parameters:

context -

getContext

java.util.Map<java.lang.String,java.lang.Object> getContext()

Get the context or an empty map if no context has been set before via setContext(Map).

Returns:

the context

getProduct

Product getProduct(java.lang.String path)
            throws CommerceException

Get the product by path.

Parameters:

path -

Returns:

The product or null if the path doesn't represent a product.

Throws:

CommerceException

getPromotion

Promotion getPromotion(java.lang.String path)
                throws CommerceException

Get the voucher by path (or ID for external promotions).

Parameters:

path -

Returns:

The promotion or null if not found.

Throws:

CommerceException

getVoucher

Voucher getVoucher(java.lang.String path)
            throws CommerceException

Get the voucher by path (or ID for external vouchers).

Parameters:

path -

Returns:

The voucher or null if not found.

Throws:

CommerceException

getProductCollection

ProductCollection getProductCollection(java.lang.String path)
                                throws CommerceException

Get the product collection by path (or ID for external product collections).

Parameters:

path -

Returns:

The product collection or null if not found.

Throws:

CommerceException

isActivated

boolean isActivated(Product product)
             throws CommerceException

Check for public availability of a product.

Parameters:

product -

Returns:

true if publicly available

Throws:

CommerceException

catalogRolloutHook

void catalogRolloutHook(Page blueprint,
                        Page catalog)
                 throws CommerceException

Called during catalog creation or update to allow the commerce implementation to perform implementation-specific actions.

The catalogRolloutHook is called after the root catalog page is created or updated.

Note: if changes are made, the appropriate lastModified dates should be updated.

Parameters:

blueprint - The catalog blueprint.

catalog - The catalog page created from the blueprint.

Throws:

CommerceException

sectionRolloutHook

void sectionRolloutHook(Page blueprint,
                        Page section)
                 throws CommerceException

Called during catalog creation or update to allow the commerce implementation to perform implementation-specific actions.

The sectionRolloutHook is called after each section page is created or updated.

Note: if changes are made, the appropriate lastModified dates should be updated.

Parameters:

blueprint - The catalog section blueprint.

section - The section page created from the blueprint.

Throws:

CommerceException

productRolloutHook

void productRolloutHook(Product productData,
                        Page productPage,
                        Product productReference)
                 throws CommerceException

Called during catalog creation or update to allow the commerce implementation to perform implementation-specific actions.

The productRolloutHook is called after each product page is created or updated.

Note: if changes are made, the appropriate lastModified dates should be updated.

Parameters:

productData - The productData for which the product page was created.

productPage - The product page created from the section blueprint's product template.

productReference - The product reference on the created/updated page.

Throws:

CommerceException

search

CommerceResult search(CommerceQuery query)
               throws CommerceException

Perform a search.

Parameters:

query - The query representing the search parameters

Returns:

a CommerceResult representing the search results

Throws:

CommerceException

getAvailablePromotions

java.util.List<Promotion> getAvailablePromotions(ResourceResolver resourceResolver)
                                          throws CommerceException

Get the list of available promotions.

Parameters:

resourceResolver - a Sling ResourceResolver instance

Returns:

A List<Promotion> containing the promotions.

Throws:

CommerceException

getOrderPredicates

java.util.List<java.lang.String> getOrderPredicates()
                                             throws CommerceException

Get the list of predicates for selecting placed orders.

Returns:

A List of order predicate names.

Throws:

CommerceException

getCountries

@Deprecated
java.util.List<java.lang.String> getCountries()
                                                   throws CommerceException

Deprecated. since 6.1, use CommerceSession.getAvailableCountries()

Get the list of supported countries.

Returns:

A List containing ISO-country-code values.

Throws:

CommerceException

getCreditCardTypes

@Deprecated
java.util.List<java.lang.String> getCreditCardTypes()
                                                         throws CommerceException

Deprecated. since 6.1, use CommerceSession.getAvailablePaymentMethods()

Get the list of supported credit-card types.

Returns:

A List containing credit-card types.

Throws:

CommerceException