Product ("The Adobe AEM Quickstart and Web Application.")

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 String RESOURCE_TYPE_PRODUCT
Base resource type for products.

Fields
Modifier and Type	Field and Description
`static String`	`RESOURCE_TYPE_PRODUCT` Base resource type for products.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`axisIsVariant(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.
`List<Resource>`	`getAssets()` Get all the assets for this product.
`Product`	`getBaseProduct()` Returns the product which forms the base of a set of variations.
`String`	`getDescription()` Returns the product's description.
`String`	`getDescription(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.
`String`	`getImagePath()` Deprecated. since 5.6.1; use `getImage()` instead.
`List<ImageResource>`	`getImages()` Get all the images for this product.
`String`	`getImageUrl()` Deprecated. since 5.6.1; use `getImage()` instead.
`String`	`getPagePath()` Get the path of the parent page which renders the product/variation.
`String`	`getPath()` Get the underlying resource's path.
`Product`	`getPIMProduct()` Returns the PIM Product (under /etc/commerce/products) which stores this product's data.
`<T> T`	`getProperty(String name, Class<T> type)` Returns a product property.
`<T> T`	`getProperty(String name, String selectorString, Class<T> type)` Return a product property based on the given selector.
`String`	`getSKU()` Get a unique identifier for a product variation.
`ImageResource`	`getThumbnail()` Deprecated. since 6.1; use `getThumbnailUrl()` instead.
`String`	`getThumbnailUrl()` Returns the URL to the product's thumbnail image.
`String`	`getThumbnailUrl(int width)` Returns the URL to the product's thumbnail image, resized to the specified width.
`String`	`getThumbnailUrl(String selectorString)` Returns the URL to the product's thumbnail image, based on the given selector string.
`String`	`getTitle()` Returns the product's title.
`String`	`getTitle(String selectorString)` Returns the product's title based on the given selector.
`Iterator<String>`	`getVariantAxes()` Returns an iterator over the property names of the variant axes.
`Iterator<Product>`	`getVariants()` Returns an iterator over the list of all product variations to which this particular product/variant belongs.
`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 String RESOURCE_TYPE_PRODUCT
```
    Base resource type for products.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getPath
```
String getPath()
```
    Get the underlying resource's path. This must be unique for a particular variation.
    
    Returns:
  - getPagePath
```
String getPagePath()
```
    Get the path of the parent page which renders the product/variation.
    
    Returns:
  - getSKU
```
String getSKU()
```
    Get a unique identifier for a product variation.
    
    Returns:
  - getTitle
```
String getTitle()
```
    Returns the product's title.
    
    Returns:
  - getTitle
```
String getTitle(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
```
String getDescription()
```
    Returns the product's description.
    
    Returns:
  - getDescription
```
String getDescription(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
```
String getThumbnailUrl()
```
    Returns the URL to the product's thumbnail image.
    
    Returns:
  - getThumbnailUrl
```
String getThumbnailUrl(int width)
```
    Returns the URL to the product's thumbnail image, resized to the specified width.
    
    Parameters:
    
    width -
    
    Returns:
  - getThumbnailUrl
```
String getThumbnailUrl(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
```
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
```
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(String name,
                  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(String name,
                  String selectorString,
                  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
```
Iterator<String> getVariantAxes()
```
    Returns an iterator over the property names of the variant axes. For instance: ["color", "size"].
    
    Returns:
  - axisIsVariant
```
boolean axisIsVariant(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
```
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
```
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 iter = product.getVariants(new EnumerateAxisFilter("size"));
```
    To get the list of sub-variants of the color "blue":
```
    Iterator 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 /etc/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
String getImageUrl()
```
    Deprecated. since 5.6.1; use getImage() instead.
    
    Returns the URL to the product's primary image.
    
    Returns:
  - getImagePath
```
@Deprecated
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:

Interface Product

Field Summary

Method Summary

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

Field Detail

RESOURCE_TYPE_PRODUCT

Method Detail

getPath

getPagePath

getSKU

getTitle

getTitle

getDescription

getDescription

getThumbnailUrl

getThumbnailUrl

getThumbnailUrl

getAsset

getAssets

getImage

getImages

getProperty

getProperty

getVariantAxes

axisIsVariant

getVariants

getVariants

getBaseProduct

getPIMProduct

getImageUrl

getImagePath

getThumbnail