Package com.broadleafcommerce.catalog.service.product.hydration

Class ResolvedProductReferences

java.lang.Object

com.broadleafcommerce.catalog.service.product.hydration.ResolvedProductReferences

public class ResolvedProductReferences
extends Object

Used by the DefaultProductHydrationService to hold the results of querying for the references.

Author:

Samarth Dhruva (samarthd)

See Also:

• ProductReferences

Constructor Summary

Constructors

Constructor	Description
ResolvedProductReferences()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Map<String,BusinessType>	getBusinessTypeByTypeKey()	Contains the results of querying for ProductReferences.getBusinessTypeTypeKeysToFind().
Map<String,Category>	getCategoriesById()	Contains the results of querying for ProductReferences.getCategoryIdsToFind().
Map<String,Characteristic>	getCharacteristicsById()	Contains the results of querying for ProductReferences.getCharacteristicIdsToFind().
Map<String,List<org.apache.commons.lang3.tuple.Pair<String,com.broadleafcommerce.translation.domain.Translation>>>	getCharacteristicValueTranslationsByCharacteristicId()	Contains the results of querying for characteristic values translations for characteristics that are assigned to a product(s).
Map<String,DataDrivenEnum>	getDataDrivenEnumsById()	Contains the results of querying for ProductReferences.getDataDrivenEnumIdsToFind().
Map<String,OptionTemplate>	getOptionTemplatesById()	Contains the results of querying for ProductReferences.getOptionTemplateIdstoFind().
Map<String,ProductAsset>	getPrimaryAssetsByProductId()	Contains the results of querying for ProductReferences.getProductIdsToFindPrimaryAssetsFor().
Map<String,Category>	getPrimaryCategoriesByProductId()	Contains the results of querying for ProductReferences.getProductIdsToFindPrimaryCategoriesFor().
Map<String,List<ProductCharacteristic>>	getProductCharacteristicsByProductId()	Contains the results of querying for ProductReferences.getProductIdsToFindProductCharacteristicsFor().
Map<String,List<ProductCharacteristic>>	getProductCharacteristicsFromInheritanceLineByProductId()	Contains the results of querying for ProductReferences.getProductIdsToFindProductCharacteristicsFor(), but includes results from the entire catalog ancestry rather than only returning the 'most-derived' results.
Map<String,List<com.broadleafcommerce.translation.domain.Translation>>	getProductCharacteristicTranslationsByProductId()	Translations for product characteristics - characteristics translated directly in product.
Map<String,Product>	getProductsById()	Contains the results of querying for ProductReferences.getProductIdsToFind().
Map<String,Variant>	getVariantsById()	Contains the results of querying for ProductReferences.getVariantIdsToFind().
int	hashCode()
void	setBusinessTypeByTypeKey(Map<String,BusinessType> businessTypeByTypeKey)	Contains the results of querying for ProductReferences.getBusinessTypeTypeKeysToFind().
void	setCategoriesById(Map<String,Category> categoriesById)	Contains the results of querying for ProductReferences.getCategoryIdsToFind().
void	setCharacteristicsById(Map<String,Characteristic> characteristicsById)	Contains the results of querying for ProductReferences.getCharacteristicIdsToFind().
void	setCharacteristicValueTranslationsByCharacteristicId(Map<String,List<org.apache.commons.lang3.tuple.Pair<String,com.broadleafcommerce.translation.domain.Translation>>> characteristicValueTranslationsByCharacteristicId)	Contains the results of querying for characteristic values translations for characteristics that are assigned to a product(s).
void	setDataDrivenEnumsById(Map<String,DataDrivenEnum> dataDrivenEnumsById)	Contains the results of querying for ProductReferences.getDataDrivenEnumIdsToFind().
void	setOptionTemplatesById(Map<String,OptionTemplate> optionTemplatesById)	Contains the results of querying for ProductReferences.getOptionTemplateIdstoFind().
void	setPrimaryAssetsByProductId(Map<String,ProductAsset> primaryAssetsByProductId)	Contains the results of querying for ProductReferences.getProductIdsToFindPrimaryAssetsFor().
void	setPrimaryCategoriesByProductId(Map<String,Category> primaryCategoriesByProductId)	Contains the results of querying for ProductReferences.getProductIdsToFindPrimaryCategoriesFor().
void	setProductCharacteristicsByProductId(Map<String,List<ProductCharacteristic>> productCharacteristicsByProductId)	Contains the results of querying for ProductReferences.getProductIdsToFindProductCharacteristicsFor().
void	setProductCharacteristicsFromInheritanceLineByProductId(Map<String,List<ProductCharacteristic>> productCharacteristicsFromInheritanceLineByProductId)	Contains the results of querying for ProductReferences.getProductIdsToFindProductCharacteristicsFor(), but includes results from the entire catalog ancestry rather than only returning the 'most-derived' results.
void	setProductCharacteristicTranslationsByProductId(Map<String,List<com.broadleafcommerce.translation.domain.Translation>> productCharacteristicTranslationsByProductId)	Translations for product characteristics - characteristics translated directly in product.
void	setProductsById(Map<String,Product> productsById)	Contains the results of querying for ProductReferences.getProductIdsToFind().
void	setVariantsById(Map<String,Variant> variantsById)	Contains the results of querying for ProductReferences.getVariantIdsToFind().
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ResolvedProductReferences

public ResolvedProductReferences()

Method Details

getProductsById

public Map<String,Product> getProductsById()

Contains the results of querying for ProductReferences.getProductIdsToFind().

getVariantsById

public Map<String,Variant> getVariantsById()

Contains the results of querying for ProductReferences.getVariantIdsToFind().

getPrimaryAssetsByProductId

public Map<String,ProductAsset> getPrimaryAssetsByProductId()

Contains the results of querying for ProductReferences.getProductIdsToFindPrimaryAssetsFor().

getPrimaryCategoriesByProductId

public Map<String,Category> getPrimaryCategoriesByProductId()

Contains the results of querying for ProductReferences.getProductIdsToFindPrimaryCategoriesFor().

getCategoriesById

public Map<String,Category> getCategoriesById()

Contains the results of querying for ProductReferences.getCategoryIdsToFind().

getDataDrivenEnumsById

public Map<String,DataDrivenEnum> getDataDrivenEnumsById()

Contains the results of querying for ProductReferences.getDataDrivenEnumIdsToFind().

getOptionTemplatesById

public Map<String,OptionTemplate> getOptionTemplatesById()

Contains the results of querying for ProductReferences.getOptionTemplateIdstoFind().

getBusinessTypeByTypeKey

public Map<String,BusinessType> getBusinessTypeByTypeKey()

Contains the results of querying for ProductReferences.getBusinessTypeTypeKeysToFind().

getCharacteristicsById

public Map<String,Characteristic> getCharacteristicsById()

Contains the results of querying for ProductReferences.getCharacteristicIdsToFind().

getProductCharacteristicsByProductId

public Map<String,List<ProductCharacteristic>> getProductCharacteristicsByProductId()

Contains the results of querying for ProductReferences.getProductIdsToFindProductCharacteristicsFor().

These results represent the 'most derived' characteristics for each product, with typical narrowing semantics applied. This means overrides from child catalogs or sandboxes are resolved to a single view per characteristic.

Since:

Catalog Service 2.3.0, Release Train 2.3.0

getProductCharacteristicsFromInheritanceLineByProductId

public Map<String,List<ProductCharacteristic>> getProductCharacteristicsFromInheritanceLineByProductId()

Contains the results of querying for ProductReferences.getProductIdsToFindProductCharacteristicsFor(), but includes results from the entire catalog ancestry rather than only returning the 'most-derived' results.

Thus, this field may contain multiple catalog representations (e.g., parent vs. child catalog) of the same logical characteristic. However, for each catalog representation, this will only contain the 'most derived' sandbox result and thus consumers don't need to account for multiple sandbox representations.

The caller is responsible for handling these multiple representations.

Since:

Catalog Service 2.3.0, Release Train 2.3.0

getCharacteristicValueTranslationsByCharacteristicId

public Map<String,List<org.apache.commons.lang3.tuple.Pair<String,com.broadleafcommerce.translation.domain.Translation>>> getCharacteristicValueTranslationsByCharacteristicId()

Contains the results of querying for characteristic values translations for characteristics that are assigned to a product(s). Map <Characteristic ID, List<Pair<Characteristic Value ID, Translation>>>

Since:

Catalog Service 2.3.0, Release Train 2.3.0

getProductCharacteristicTranslationsByProductId

public Map<String,List<com.broadleafcommerce.translation.domain.Translation>> getProductCharacteristicTranslationsByProductId()

Translations for product characteristics - characteristics translated directly in product.

Since:

Catalog Service 2.3.0, Release Train 2.3.0

setProductsById

public void setProductsById(Map<String,Product> productsById)

Contains the results of querying for ProductReferences.getProductIdsToFind().

setVariantsById

public void setVariantsById(Map<String,Variant> variantsById)

Contains the results of querying for ProductReferences.getVariantIdsToFind().

setPrimaryAssetsByProductId

public void setPrimaryAssetsByProductId(Map<String,ProductAsset> primaryAssetsByProductId)

Contains the results of querying for ProductReferences.getProductIdsToFindPrimaryAssetsFor().

setPrimaryCategoriesByProductId

public void setPrimaryCategoriesByProductId(Map<String,Category> primaryCategoriesByProductId)

Contains the results of querying for ProductReferences.getProductIdsToFindPrimaryCategoriesFor().

setCategoriesById

public void setCategoriesById(Map<String,Category> categoriesById)

Contains the results of querying for ProductReferences.getCategoryIdsToFind().

setDataDrivenEnumsById

public void setDataDrivenEnumsById(Map<String,DataDrivenEnum> dataDrivenEnumsById)

Contains the results of querying for ProductReferences.getDataDrivenEnumIdsToFind().

setOptionTemplatesById

public void setOptionTemplatesById(Map<String,OptionTemplate> optionTemplatesById)

Contains the results of querying for ProductReferences.getOptionTemplateIdstoFind().

setBusinessTypeByTypeKey

public void setBusinessTypeByTypeKey(Map<String,BusinessType> businessTypeByTypeKey)

Contains the results of querying for ProductReferences.getBusinessTypeTypeKeysToFind().

setCharacteristicsById

public void setCharacteristicsById(Map<String,Characteristic> characteristicsById)

Contains the results of querying for ProductReferences.getCharacteristicIdsToFind().

setProductCharacteristicsByProductId

public void setProductCharacteristicsByProductId(Map<String,List<ProductCharacteristic>> productCharacteristicsByProductId)

Contains the results of querying for ProductReferences.getProductIdsToFindProductCharacteristicsFor().

These results represent the 'most derived' characteristics for each product, with typical narrowing semantics applied. This means overrides from child catalogs or sandboxes are resolved to a single view per characteristic.

Since:

Catalog Service 2.3.0, Release Train 2.3.0

setProductCharacteristicsFromInheritanceLineByProductId

public void setProductCharacteristicsFromInheritanceLineByProductId(Map<String,List<ProductCharacteristic>> productCharacteristicsFromInheritanceLineByProductId)

Contains the results of querying for ProductReferences.getProductIdsToFindProductCharacteristicsFor(), but includes results from the entire catalog ancestry rather than only returning the 'most-derived' results.

Thus, this field may contain multiple catalog representations (e.g., parent vs. child catalog) of the same logical characteristic. However, for each catalog representation, this will only contain the 'most derived' sandbox result and thus consumers don't need to account for multiple sandbox representations.

The caller is responsible for handling these multiple representations.

Since:

Catalog Service 2.3.0, Release Train 2.3.0

setCharacteristicValueTranslationsByCharacteristicId

public void setCharacteristicValueTranslationsByCharacteristicId(Map<String,List<org.apache.commons.lang3.tuple.Pair<String,com.broadleafcommerce.translation.domain.Translation>>> characteristicValueTranslationsByCharacteristicId)

Contains the results of querying for characteristic values translations for characteristics that are assigned to a product(s). Map <Characteristic ID, List<Pair<Characteristic Value ID, Translation>>>

Since:

Catalog Service 2.3.0, Release Train 2.3.0

setProductCharacteristicTranslationsByProductId

public void setProductCharacteristicTranslationsByProductId(Map<String,List<com.broadleafcommerce.translation.domain.Translation>> productCharacteristicTranslationsByProductId)

Translations for product characteristics - characteristics translated directly in product.

Since:

Catalog Service 2.3.0, Release Train 2.3.0

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object