com.adobe.cq.commerce.api.asset

Interface ProductAssetManager

public interface ProductAssetManager

The ProductAssetManager provides methods to retrieve, update, create and update product assets. A product asset is a resource in the repository and has properties that define its rendering, e.g. the path to the referenced asset, the resource type to render it, a width, a height, ...

Method Summary

Modifier and Type	Method and Description
Resource	addAsset(Product product, java.util.Map<java.lang.String,java.lang.Object> productAssetProperties) Adds a product asset to the product.
Resource	addAsset(Product product, java.lang.String assetReference) Adds a product asset to the product.
Resource	getAsset(Product product) Returns the product asset that best represents the product.
java.util.List<Resource>	getAssets(Product product) Returns the product assets belonging to the product.
java.lang.String	getReferencedAsset(java.lang.String productAssetPath) Returns the path to the referenced asset.
java.lang.String	getThumbnailUrl(Product product, java.lang.String selectorString) Returns the URL to the product's thumbnail image, based on the given selector string.
java.lang.String	getThumbnailUrl(java.lang.String productAssetPath, java.lang.String selectorString) Returns the URL to the product's thumbnail image, based on the given selector string.
boolean	isSupportedAsset(java.lang.String productAssetPath) Indicates whether the product asset at path productAssetPath is supported.
boolean	isSupportedReferencedAsset(java.lang.String assetReference) Indicates whether the asset referenced by assetReference is supported.
void	removeAsset(java.lang.String productAssetPath) Removes the product asset.
Resource	updateAsset(java.lang.String productAssetPath, java.util.Map<java.lang.String,java.lang.Object> productAssetProperties) Updates the address.
Resource	updateAsset(java.lang.String productAssetPath, java.lang.String assetReference) Updates the address.

Method Detail

isSupportedReferencedAsset

boolean isSupportedReferencedAsset(java.lang.String assetReference)

Indicates whether the asset referenced by assetReference is supported.

Parameters:

assetReference - the asset path in the repository

Returns:

true if the asset is supported, false otherwise

isSupportedAsset

boolean isSupportedAsset(java.lang.String productAssetPath)

Indicates whether the product asset at path productAssetPath is supported.

Parameters:

productAssetPath - the path of the product asset

Returns:

true if the product asset is supported, false otherwise

getReferencedAsset

java.lang.String getReferencedAsset(java.lang.String productAssetPath)

Returns the path to the referenced asset.

Parameters:

productAssetPath - the path of the product asset

Returns:

The path to the referenced asset

getAsset

Resource getAsset(Product product)

Returns the product asset that best represents the product.

Parameters:

product - The product

Returns:

The product asset or null if there is none

getAssets

java.util.List<Resource> getAssets(Product product)

Returns the product assets belonging to the product.

Parameters:

product - The product

Returns:

The product assets or null if there are none

getThumbnailUrl

java.lang.String getThumbnailUrl(Product product,
                                 java.lang.String selectorString)

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

Parameters:

product - The product

selectorString - The selector string

Returns:

The thumbnail URL or null if there is none

getThumbnailUrl

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

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

Parameters:

productAssetPath - The path to the product asset

selectorString - The selector string

Returns:

The product assets or null if there are none

addAsset

Resource addAsset(Product product,
                  java.lang.String assetReference)
           throws CommerceException

Adds a product asset to the product.

Parameters:

product - The product

assetReference - The path to the referenced asset

Returns:

The new product asset

Throws:

CommerceException - when the operation fails.

addAsset

Resource addAsset(Product product,
                  java.util.Map<java.lang.String,java.lang.Object> productAssetProperties)
           throws CommerceException

Adds a product asset to the product.

Parameters:

product - The product

productAssetProperties - The rendering properties of the product asset

Returns:

The new product asset

Throws:

CommerceException - when the operation fails.

updateAsset

Resource updateAsset(java.lang.String productAssetPath,
                     java.lang.String assetReference)
              throws CommerceException

Updates the address.

Parameters:

productAssetPath - The path of the product asset

assetReference - The path to the referenced asset

Returns:

The updated product asset

Throws:

CommerceException - when the operation fails.

updateAsset

Resource updateAsset(java.lang.String productAssetPath,
                     java.util.Map<java.lang.String,java.lang.Object> productAssetProperties)
              throws CommerceException

Updates the address.

Parameters:

productAssetPath - The path of the product asset

productAssetProperties - The rendering properties of the product asset

Returns:

The updated product asset

Throws:

CommerceException - when the operation fails.

removeAsset

void removeAsset(java.lang.String productAssetPath)
          throws CommerceException

Removes the product asset.

Parameters:

productAssetPath - The path of the product asset

Throws:

CommerceException - when the operation fails.