com.adobe.cq.commerce.api.classification

Interface ClassificationManager

public interface ClassificationManager

The ClassificationManager provides methods to retrieve, update, create and update product classifications. Since 6.2

Method Summary

Modifier and Type	Method and Description
ClassificationAttribute	addAttribute(java.lang.String categoryPath, java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> properties) Adds an attribute to the specified category.
ClassificationCategory	addCategory(java.lang.String parentPath, java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> properties) Adds a sub category to the specified category.
ClassificationCategory	addRootCategory(java.lang.String classificationPath, java.util.Map<java.lang.String,java.lang.Object> properties) Adds a root category to the classification.
void	assignProducts(java.lang.String categoryPath, java.util.Map<java.lang.String,java.lang.Object> productListDefinition) Assigns products to the category.
Classification	createClassification(java.lang.String parentPath, java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> properties) Creates a product classification with a given name under the parentPath.
ClassificationAttribute	getAttribute(java.lang.String path) Returns a classification attribute for the given path or an ID uniquely identifying the ClassificationAttribute to the external commerce engine.
ClassificationCategory	getCategory(java.lang.String path) Returns a classification category for the given path or an ID uniquely identifying the ClassificationCategory to the external commerce engine.
Classification	getClassification(java.lang.String path) Returns a product classification for the given path or an ID uniquely identifying the Classification to the external commerce engine.
java.util.Collection<ClassificationCategory>	getClassificationCategories(java.util.List<Product> products) Retrieves the classification categories in which at least one of the product is assigned.
java.util.Collection<ClassificationCategory>	getClassificationCategories(Product product) Retrieves the classification categories in which the product is assigned.
java.util.Collection<Classification>	getClassifications(java.util.List<Product> products) Retrieves the classifications in which at least one of the product is assigned.
java.util.Collection<Classification>	getClassifications(Product product) Retrieves the classifications in which the product is assigned.
void	orderBefore(java.lang.String srcAttributePath, java.lang.String destAttributePath) Inserts the referenced attribute srcAttributePath into the list of attributes at the position immediately before the referenced attribute destAttributePath.
void	removeAttribute(java.lang.String path) Removes the attribute.
void	removeCategory(java.lang.String path) Removes the category.
void	removeClassification(java.lang.String path) Removes the classification.
void	updateAttribute(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> properties) Updates the attribute.
void	updateCategory(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> properties) Updates the category.
void	updateClassification(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> properties) Updates the classification.

Method Detail

getClassification

Classification getClassification(java.lang.String path)

Returns a product classification for the given path or an ID uniquely identifying the Classification to the external commerce engine. It returns null if given path/ID is not a product classification or is not defined

Parameters:

path - path/ID that represents the classification

Returns:

The Classification representing the classification.

getCategory

ClassificationCategory getCategory(java.lang.String path)

Returns a classification category for the given path or an ID uniquely identifying the ClassificationCategory to the external commerce engine. It returns null if given path/ID is not a classification category or is not defined

Parameters:

path - path/ID that represents the category

Returns:

The ClassificationCategory representing the category.

getAttribute

ClassificationAttribute getAttribute(java.lang.String path)

Returns a classification attribute for the given path or an ID uniquely identifying the ClassificationAttribute to the external commerce engine. It returns null if given path/ID is not a classification attribute or is not defined

Parameters:

path - path/ID that represents the attribute

Returns:

The ClassificationAttribute representing the attribute.

createClassification

Classification createClassification(java.lang.String parentPath,
                                    java.lang.String name,
                                    java.util.Map<java.lang.String,java.lang.Object> properties)
                             throws CommerceException

Creates a product classification with a given name under the parentPath.

Parameters:

parentPath - parent path where classification needs to be created.

name - The name for classification.

properties - The additional data for product classification

Returns:

The Classification representing the created classification.

Throws:

CommerceException - if the classification was not created

removeClassification

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

Removes the classification.

Parameters:

path - path/ID that represents the classification

Throws:

CommerceException - if the classification was not removed

updateClassification

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

Updates the classification.

Parameters:

path - path/ID that represents the classification

properties - The additional data for product classification

Throws:

CommerceException - if the classification was not updated

addRootCategory

ClassificationCategory addRootCategory(java.lang.String classificationPath,
                                       java.util.Map<java.lang.String,java.lang.Object> properties)
                                throws CommerceException

Adds a root category to the classification. The root category is the base category of the classification and does not have a parent category.

Parameters:

classificationPath - path/ID that represents the classification

properties - The additional data for the root category

Returns:

The ClassificationCategory representing the created category.

Throws:

CommerceException - if the root category was not created or if the classification already has a root category

addCategory

ClassificationCategory addCategory(java.lang.String parentPath,
                                   java.lang.String name,
                                   java.util.Map<java.lang.String,java.lang.Object> properties)
                            throws CommerceException

Adds a sub category to the specified category.

Parameters:

parentPath - parent path / ID that represents the parent category

properties - The additional data for the category

Returns:

The ClassificationCategory representing the created category.

Throws:

CommerceException - if the category was not created

removeCategory

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

Removes the category.

Parameters:

path - path/ID that represents the category

Throws:

CommerceException - if the category was not removed

updateCategory

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

Updates the category.

Parameters:

path - path/ID that represents the category

properties - The additional data for the category

Throws:

CommerceException - if the category was not updated

addAttribute

ClassificationAttribute addAttribute(java.lang.String categoryPath,
                                     java.lang.String name,
                                     java.util.Map<java.lang.String,java.lang.Object> properties)
                              throws CommerceException

Adds an attribute to the specified category.

Parameters:

categoryPath - path/ID that represents the category

properties - The additional data for the attribute

Returns:

The ClassificationAttribute representing the created attribute.

Throws:

CommerceException - if the attribute was not created

removeAttribute

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

Removes the attribute.

Parameters:

path - path/ID that represents the attribute

Throws:

CommerceException - if the attribute was not removed

updateAttribute

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

Updates the attribute.

Parameters:

path - path/ID that represents the attribute

properties - The additional data for the attribute

Throws:

CommerceException - if the attribute was not updated

orderBefore

void orderBefore(java.lang.String srcAttributePath,
                 java.lang.String destAttributePath)
          throws CommerceException

Inserts the referenced attribute srcAttributePath into the list of attributes at the position immediately before the referenced attribute destAttributePath. To insert the referenced attribute into last position, destAttributePath can be null.

Parameters:

srcAttributePath - Referenced attribute path/ID that needs to be moved in the order

destAttributePath - Referenced attribute path/ID before which the srcAttributePath will be placed.

Throws:

CommerceException - if the operation fails

assignProducts

void assignProducts(java.lang.String categoryPath,
                    java.util.Map<java.lang.String,java.lang.Object> productListDefinition)
             throws CommerceException

Assigns products to the category.

Parameters:

categoryPath - path/ID that represents the category

productListDefinition - A map of properties (key-value pairs) defining a set of products (can be used e.g. to define a query or a tag-based search)

Throws:

CommerceException - if the operation failed

getClassifications

java.util.Collection<Classification> getClassifications(Product product)

Retrieves the classifications in which the product is assigned.

Parameters:

product - The product

Returns:

A list of Classifications in which the product is assigned.

getClassificationCategories

java.util.Collection<ClassificationCategory> getClassificationCategories(Product product)

Retrieves the classification categories in which the product is assigned.

Parameters:

product - The product

Returns:

A list of ClassificationCategorys in which the product is assigned.

getClassifications

java.util.Collection<Classification> getClassifications(java.util.List<Product> products)

Retrieves the classifications in which at least one of the product is assigned.

Parameters:

products - The list of products

Returns:

A list of Classifications in which the products are assigned.

getClassificationCategories

java.util.Collection<ClassificationCategory> getClassificationCategories(java.util.List<Product> products)

Retrieves the classification categories in which at least one of the product is assigned.

Parameters:

products - The list of products

Returns:

A list of ClassificationCategorys in which the products are assigned.