com.adobe.cq.commerce.api

Interface ProductRelationship

All Known Implementing Classes:

DefaultProductRelationship

public interface ProductRelationship

A ProductRelationship provides information about a relationship between some context (shopper, cart, page and/or product) and a product.

Additional metadata regarding either the relationship or the product can also be included. See ProductRelationshipsProvider for further details.

Method Summary

Modifier and Type	Method and Description
ValueMap	getMetadata()
Product	getProduct()
String	getRelationshipTitle()
String	getRelationshipType()

Method Detail

getRelationshipType

String getRelationshipType()

Returns:

a string token identifying the relationship type (cross-sell, warranty, best-seller, trending-product, etc.)

getRelationshipTitle

String getRelationshipTitle()

Returns:

a string identifying the relationship type to an author

getProduct

Product getProduct()

Returns:

the related product

getMetadata

ValueMap getMetadata()

Returns:

a read-/write-able collection of metadata regarding the product and/or relationship