com.adobe.cq.commerce.api.collection

Interface ProductCollection

All Known Subinterfaces:

SmartList

All Known Implementing Classes:

AbstractProductCollection

@ProviderType
public interface ProductCollection

ProductCollection is an ordered collection of either product or product collection references. The collection does not store the actual products/collections, it only points to them.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String path) Creates a new entry (product or collection) in the collection at the last position
boolean	contains(Product product) Returns true if product reference is part of the collection.
java.lang.String	getDescription() Returns the description of the collection.
java.util.Iterator<java.lang.String>	getDirectReferences() Returns an iterator over product or collection paths/IDs directly referenced in the collection.
java.lang.String	getPath() Returns the path of the collection if represented in the repository.
java.util.Iterator<Product>	getProducts() Returns an iterator over products referred in the collection in the specified order.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Returns the collection properties.
<T> T	getProperty(java.lang.String key, java.lang.Class<T> type) Returns a named collection property converted to a given type.
<T> T	getProperty(java.lang.String key, T defaultValue) Returns a named collection property or a default value if the property can not be retrieved.
java.lang.String	getTitle() Returns the title of the collection.
java.lang.String	getType() Returns the type of the collection.
boolean	hasDirectReference(java.lang.String path) Returns true if the product or the collection referenced by the path/ID is directly referenced in the collection.
void	orderBefore(java.lang.String srcPath, java.lang.String destPath) Inserts the referenced product or collection srcPath into the collection entry at the position immediately before the referenced product or collection destPath.
void	remove(java.lang.String path) Removes an entry of product or collection from collection.
void	setProperties(java.util.Map<java.lang.String,java.lang.Object> properties) Sets the collection properties.
void	setProperty(java.lang.String key, java.lang.Object value) Sets a collection property.

Method Detail

getTitle

java.lang.String getTitle()

Returns the title of the collection.

Returns:

title of the collection.

getDescription

java.lang.String getDescription()

Returns the description of the collection.

Returns:

description of the collection.

getType

java.lang.String getType()

Returns the type of the collection.

Returns:

type of the collection.

getPath

java.lang.String getPath()

Returns the path of the collection if represented in the repository. Otherwise, it returns an ID uniquely identifying the collection to the external commerce engine.

Returns:

path/ID of the collection.

getProperties

java.util.Map<java.lang.String,java.lang.Object> getProperties()

Returns the collection properties.

Returns:

The collection properties as an unmodifiable Map.

getProperty

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

Returns a named collection property converted to a given type.

Parameters:

key - The name of the property

type - The type to which the property should be converted.

Returns:

The named value converted to type T.

getProperty

<T> T getProperty(java.lang.String key,
                  T defaultValue)

Returns a named collection property or a default value if the property can not be retrieved.

Parameters:

key - The name of the property

defaultValue - The default value to use if the named property does not exist or cannot be converted to the requested type. The default value is also used to define the type to convert the value to. If this is null any existing property is not converted.

Returns:

The named value converted to type T or the default value if non existing or can't be converted.

setProperties

void setProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
            throws CommerceException

Sets the collection properties. New properties are added, existing ones are replaced.

Parameters:

properties - The new collection properties.

Throws:

CommerceException - if setting the properties fails.

setProperty

void setProperty(java.lang.String key,
                 java.lang.Object value)
          throws CommerceException

Sets a collection property.

Parameters:

key - The name of the property

value - The value of the property

Throws:

CommerceException - if setting the properties fails.

getDirectReferences

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

Returns an iterator over product or collection paths/IDs directly referenced in the collection. These are the first level descendants of the collection as opposed to all levels descendant products returned by getProducts()

Returns:

iterator over product or collection paths/IDs directly referred in collection.

hasDirectReference

boolean hasDirectReference(java.lang.String path)

Returns true if the product or the collection referenced by the path/ID is directly referenced in the collection. To check if a product is part of all levels descendants of the collection, use contains(com.adobe.cq.commerce.api.Product).

Parameters:

path - product or collection path to be added, if the product/collection is represented in the repository. Otherwise, it is an ID uniquely identifying the product/collection to the external commerce engine.

Returns:

true if product or collection path is part of the collection. false otherwise

getProducts

java.util.Iterator<Product> getProducts()

Returns an iterator over products referred in the collection in the specified order.

Returns:

iterator over products referred in collection.

contains

boolean contains(Product product)

Returns true if product reference is part of the collection.

Parameters:

product - product to be checked

Returns:

true if product is part of the collection. false otherwise

add

void add(java.lang.String path)
  throws CommerceException

Creates a new entry (product or collection) in the collection at the last position

Parameters:

path - product or collection path to be added, if the product/collection is represented in the repository. Otherwise, it is an ID uniquely identifying the product/collection to the external commerce engine.

Throws:

CommerceException - if the operation fails, if collection already contained the product/collection or product/collection is null.

remove

void remove(java.lang.String path)
     throws CommerceException

Removes an entry of product or collection from collection.

Parameters:

path - product or collection path to be added, if the product/collection is represented in the repository. Otherwise, it is an ID uniquely identifying the product/collection to the external commerce engine.

Throws:

CommerceException - if the operation fails, or if product/collection reference was not removed / not present

orderBefore

void orderBefore(java.lang.String srcPath,
                 java.lang.String destPath)
          throws CommerceException

Inserts the referenced product or collection srcPath into the collection entry at the position immediately before the referenced product or collection destPath. To insert the referenced product/collection into last position, destPath can be null.

Parameters:

srcPath - Referenced product/collection path/ID that needs to be moved in the order

destPath - Referenced product/collection path/ID before which the srcPath will be placed.

Throws:

CommerceException - if the operation fails