org.broadleafcommerce.core.web.processor

Class RelatedProductProcessor

java.lang.Object

org.broadleafcommerce.presentation.dialect.AbstractBroadleafVariableModifierProcessor

org.broadleafcommerce.core.web.processor.RelatedProductProcessor

All Implemented Interfaces:

org.broadleafcommerce.presentation.dialect.BroadleafProcessor, org.broadleafcommerce.presentation.dialect.BroadleafVariableModifierProcessor

Deprecated.

in favor of RelatedProductsVariableExpression

@Component(value="blRelatedProductProcessor")
 @ConditionalOnTemplating
 @Deprecated
public class RelatedProductProcessor
extends org.broadleafcommerce.presentation.dialect.AbstractBroadleafVariableModifierProcessor

A Thymeleaf processor that will find related products and skus. A product or category id must be specified. If both are specified, only the productId will be used. Takes in the following parameters

• productId - productId to find related products.
• categoryId - categoryId to find related products.
• type - the type of relations to find (e.g. FEATURED (DEFAULT), UPSELL, CROSSSELL). Implementations may have other specific types of related products.
• cumulativeResults - true (DEFAULT) /false - indicates that the system should add results from the parent categories of the passed in item as well as the current item
• qty - if specified, determines the max-number of results that will be returned; otherwise, all results are returned.
• productsResultVar - if specified, adds the products to the model keyed by this var. Otherwise, uses "products" as the model identifier.
• relatedProductsResultVar - if specified, adds the RelatedProduct(s) to the model keyed by this var. Otherwise, uses "relatedProducts" as the model identifier.
• relatedSkusResultVar - if specified, adds the related skus to the model keyed by this var. Otherwise, uses "relatedSkus" as the model identifier.

The output from this operation returns a list of PromotableProducts which represent the following. relatedProduct.product relatedProduct.promotionMessage.

Author:

bpolster

Field Summary

Fields

Modifier and Type	Field and Description
protected RelatedProductsService	relatedProductsService Deprecated.
protected boolean	useSku Deprecated.

Fields inherited from interface org.broadleafcommerce.presentation.dialect.BroadleafProcessor

DEFAULT_PRECEDENCE, DEFAULT_PREFIX

Constructor Summary

Constructors

Constructor and Description
RelatedProductProcessor() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected List<Product>	buildProductList(List<? extends PromotableProduct> relatedProducts) Deprecated.
protected List<Product>	convertRelatedProductsToProducts(List<? extends PromotableProduct> relatedProducts) Deprecated.
List<String>	getCollectionModelVariableNamesToAddTo() Deprecated.
String	getName() Deprecated.
int	getPrecedence() Deprecated.
protected List<Sku>	getRelatedSkus(List<? extends PromotableProduct> relatedProducts, Integer maxQuantity) Deprecated.
Map<String,Object>	populateModelVariables(String tagName, Map<String,String> tagAttributes, org.broadleafcommerce.presentation.model.BroadleafTemplateContext context) Deprecated. Controller method for the processor that readies the service call and adds the results to the model.

Methods inherited from class org.broadleafcommerce.presentation.dialect.AbstractBroadleafVariableModifierProcessor

getPrefix, useGlobalScope

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

useSku

@Value(value="${solr.index.use.sku}")
protected boolean useSku

Deprecated.

relatedProductsService

protected RelatedProductsService relatedProductsService

Deprecated.

Constructor Detail

RelatedProductProcessor

public RelatedProductProcessor()

Deprecated.

Method Detail

getName

public String getName()

Deprecated.

getPrecedence

public int getPrecedence()

Deprecated.

Specified by:

getPrecedence in interface org.broadleafcommerce.presentation.dialect.BroadleafProcessor

Overrides:

getPrecedence in class org.broadleafcommerce.presentation.dialect.AbstractBroadleafVariableModifierProcessor

getCollectionModelVariableNamesToAddTo

public List<String> getCollectionModelVariableNamesToAddTo()

Deprecated.

Specified by:

getCollectionModelVariableNamesToAddTo in interface org.broadleafcommerce.presentation.dialect.BroadleafVariableModifierProcessor

Overrides:

getCollectionModelVariableNamesToAddTo in class org.broadleafcommerce.presentation.dialect.AbstractBroadleafVariableModifierProcessor

populateModelVariables

public Map<String,Object> populateModelVariables(String tagName,
                                                 Map<String,String> tagAttributes,
                                                 org.broadleafcommerce.presentation.model.BroadleafTemplateContext context)

Deprecated.

Controller method for the processor that readies the service call and adds the results to the model.

buildProductList

protected List<Product> buildProductList(List<? extends PromotableProduct> relatedProducts)

Deprecated.

getRelatedSkus

protected List<Sku> getRelatedSkus(List<? extends PromotableProduct> relatedProducts,
                                   Integer maxQuantity)

Deprecated.

convertRelatedProductsToProducts

protected List<Product> convertRelatedProductsToProducts(List<? extends PromotableProduct> relatedProducts)

Deprecated.