com.adobe.cq.commerce.api

Interface Product

All Superinterfaces:

Adaptable

All Known Implementing Classes:

AbstractJcrProduct

public interface Product
extends Adaptable

The Product interface reflects resources that represent products and their variants in an e-commerce system. Products have properties. Properties which drive product variation are known as "variant axes". Note that this does not include properties which change as a result of variation, such as "shipping-weight" or "price". Each product variation must have a unique resource. Hierarchy above those leaf resources may or may not be present, depending on the PIM architecture, but if present should also be modelled by the Product interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESOURCE_TYPE_PRODUCT Base resource type for products.

Method Summary

Modifier and Type	Method and Description
boolean	axisIsVariant(java.lang.String axis) Tests a single axis (property) for variation.
Resource	getAsset() Get the primary asset for this product, or null if no asset was found.
java.util.List<Resource>	getAssets() Get all the assets for this product.
Product	getBaseProduct() Returns the product which forms the base of a set of variations.
java.lang.String	getDescription() Returns the product's description.
java.lang.String	getDescription(java.lang.String selectorString) Returns the product's description based on the given selector.
ImageResource	getImage() Get the primary image for this product, or null if no image was found.
java.lang.String	getImagePath() Deprecated. since 5.6.1; use getImage() instead.
java.util.List<ImageResource>	getImages() Get all the images for this product.
java.lang.String	getImageUrl() Deprecated. since 5.6.1; use getImage() instead.
java.lang.String	getPagePath() Get the path of the parent page which renders the product/variation.
java.lang.String	getPath() Get the underlying resource's path.
Product	getPIMProduct() Returns the PIM Product (under /var/commerce/products) which stores this product's data.
<T> T	getProperty(java.lang.String name, java.lang.Class<T> type) Returns a product property.
<T> T	getProperty(java.lang.String name, java.lang.String selectorString, java.lang.Class<T> type) Return a product property based on the given selector.
java.lang.String	getSKU() Get a unique identifier for a product variation.
ImageResource	getThumbnail() Deprecated. since 6.1; use getThumbnailUrl() instead.
java.lang.String	getThumbnailUrl() Returns the URL to the product's thumbnail image.
java.lang.String	getThumbnailUrl(int width) Returns the URL to the product's thumbnail image, resized to the specified width.
java.lang.String	getThumbnailUrl(java.lang.String selectorString) Returns the URL to the product's thumbnail image, based on the given selector string.
java.lang.String	getTitle() Returns the product's title.
java.lang.String	getTitle(java.lang.String selectorString) Returns the product's title based on the given selector.
java.util.Iterator<java.lang.String>	getVariantAxes() Returns an iterator over the property names of the variant axes.
java.util.Iterator<Product>	getVariants() Returns an iterator over the list of all product variations to which this particular product/variant belongs.
java.util.Iterator<Product>	getVariants(VariantFilter filter) Returns an iterator over the list of product variants for this product filtered by the VariantFilter.

Methods inherited from interface org.apache.sling.api.adapter.Adaptable

adaptTo

Field Detail

RESOURCE_TYPE_PRODUCT

static final java.lang.String RESOURCE_TYPE_PRODUCT

Base resource type for products.

See Also:

Constant Field Values

Method Detail

getPath

java.lang.String getPath()

Get the underlying resource's path. This must be unique for a particular variation.

Returns:

getPagePath

java.lang.String getPagePath()

Get the path of the parent page which renders the product/variation.

Returns:

getSKU

java.lang.String getSKU()

Get a unique identifier for a product variation.

Returns:

getTitle

java.lang.String getTitle()

Returns the product's title.

Returns:

getTitle

java.lang.String getTitle(java.lang.String selectorString)

Returns the product's title based on the given selector.

The selector is often a language token, but could also be a regional identifier or some other discriminator.

Parameters:

selectorString -

Returns:

Since:

6.1

getDescription

java.lang.String getDescription()

Returns the product's description.

Returns:

getDescription

java.lang.String getDescription(java.lang.String selectorString)

Returns the product's description based on the given selector.

The selector is often a language token, but could also be a regional identifier or some other discriminator.

Parameters:

selectorString -

Returns:

Since:

6.1

getThumbnailUrl

java.lang.String getThumbnailUrl()

Returns the URL to the product's thumbnail image.

Returns:

getThumbnailUrl

java.lang.String getThumbnailUrl(int width)

Returns the URL to the product's thumbnail image, resized to the specified width.

Parameters:

width -

Returns:

getThumbnailUrl

java.lang.String getThumbnailUrl(java.lang.String selectorString)

Returns the URL to the product's thumbnail image, based on the given selector string.

The selector is often a size or orientation specification, but could also be used for language- or region-specific images.

Parameters:

selectorString -

Returns:

getAsset

Resource getAsset()

Get the primary asset for this product, or null if no asset was found.

Returns:

getAssets

java.util.List<Resource> getAssets()

Get all the assets for this product. Can return an empty list if no assets were found.

Returns:

getImage

ImageResource getImage()

Get the primary image for this product, or null if no image was found.

Returns:

Since:

5.6.1

getImages

java.util.List<ImageResource> getImages()

Get all the images for this product. Can return an empty list if no images were found.

Returns:

Since:

5.6.1

getProperty

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

Returns a product property.

Parameters:

name - The property name

type - The type the property value should be converted to

Returns:

getProperty

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

Return a product property based on the given selector.

The selector is often a language token, but could also be a regional identifier or some other discriminator.

Type Parameters:

T -

Parameters:

name -

selectorString -

type -

Returns:

Since:

6.1

getVariantAxes

java.util.Iterator<java.lang.String> getVariantAxes()

Returns an iterator over the property names of the variant axes. For instance: ["color", "size"].

Returns:

axisIsVariant

boolean axisIsVariant(java.lang.String axis)

Tests a single axis (property) for variation.

Parameters:

axis - The name of the property

Returns:

true if the given axis is variant

getVariants

java.util.Iterator<Product> getVariants()
                                 throws CommerceException

Returns an iterator over the list of all product variations to which this particular product/variant belongs. Within a hierarchy this routine should return the leaf nodes, regardless of the intervening nodes or the point of entry. For instance, given:

    coat/
        coat-blue/
            coat-blue-S
            coat-blue-M
        coat-green/
            coat-green-S

it must return [coat-blue-S, coat-blue-M, coat-green-S] whether called from the Product representing coat or coat-green-S.

Returns:

Throws:

CommerceException

getVariants

java.util.Iterator<Product> getVariants(VariantFilter filter)
                                 throws CommerceException

Returns an iterator over the list of product variants for this product filtered by the VariantFilter.

Example usages:

To get the complete list of sizes, irrespective of color:

    Iterator<Product> iter = product.getVariants(new EnumerateAxisFilter("size"));

To get the list of sub-variants of the color "blue":

    Iterator<Product> iter = product.getVariants(new AxisFilter("color", "blue"));

Returns:

Throws:

CommerceException

See Also:

VariantFilter, EnumerateAxisFilter, AxisFilter

getBaseProduct

Product getBaseProduct()
                throws CommerceException

Returns the product which forms the base of a set of variations. If called on a Product which is already the base, will return this.

Returns:

The base Product

Throws:

CommerceException

getPIMProduct

Product getPIMProduct()
               throws CommerceException

Returns the PIM Product (under /var/commerce/products) which stores this product's data. (Will return null for products which don't refer to PIM data.)

Returns:

The PIM Product

Throws:

CommerceException

getImageUrl

@Deprecated
java.lang.String getImageUrl()

Deprecated. since 5.6.1; use getImage() instead.

Returns the URL to the product's primary image.

Returns:

getImagePath

@Deprecated
java.lang.String getImagePath()

Deprecated. since 5.6.1; use getImage() instead.

Returns the JCR path to the product's primary image.

Returns:

getThumbnail

@Deprecated
ImageResource getThumbnail()

Deprecated. since 6.1; use getThumbnailUrl() instead.

Get a thumbnail for this product, or null if no thumbnail was found.

Returns: