com.adobe.cq.commerce.api

Interface ProductRelationshipsProvider

@ProviderType
public interface ProductRelationshipsProvider

A ProductRelationshipsProvider provides a list of ProductRelationships for a particular context (shopper, cart, page, product).

It should be noted that the out-of-the-box RelatedProducts ClientContext store includes the product's SKU, title, imageUrl and path, and all the relationship's metadata, into the ClientContext. A RelationshipsProvider can therefore chose to have other product fields included in the ClientContext simply by copying them to the relationship's metadata.

As an example, one might include two properties regarding the relationship (source and message), and an additional product property (the price):

• source: "order-history"
• message: "Recommended because you purchased 'Amy Winehouse' in the past"
• price: "$12.50"

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RELATIONSHIP_TYPE_PN Implementations which support only a single relationshipType are encouraged to place that relationshipType into an OSGi property so that ProductRelationshipsProviders can be selected by type.

Method Summary

Modifier and Type	Method and Description
java.util.List<ProductRelationship>	getRelationships(SlingHttpServletRequest request, CommerceSession session, Page page, Product product)
java.util.Map<java.lang.String,java.lang.String>	getRelationshipTypes()

Field Detail

RELATIONSHIP_TYPE_PN

static final java.lang.String RELATIONSHIP_TYPE_PN

Implementations which support only a single relationshipType are encouraged to place that relationshipType into an OSGi property so that ProductRelationshipsProviders can be selected by type.

See Also:

Constant Field Values

Method Detail

getRelationshipTypes

java.util.Map<java.lang.String,java.lang.String> getRelationshipTypes()

Returns:

a map which maps the relationshipTypes supported by this provider to their relationshipTitles)

getRelationships

java.util.List<ProductRelationship> getRelationships(SlingHttpServletRequest request,
                                                     CommerceSession session,
                                                     Page page,
                                                     Product product)
                                              throws CommerceException

Parameters:

request - A request representing the current user

session - The current commerce session (cart, order)

page - The current page

product - The current product (if applicable)

Returns:

a list of ProductRelationships for a given context (user, cart, page, product)

Throws:

CommerceException