Package com.broadleafcommerce.catalog.service.product.characteristic

Interface CharacteristicsTranslationService

All Known Implementing Classes:

DefaultCharacteristicsTranslationService

public interface CharacteristicsTranslationService

Service interface responsible for applying translations to product characteristics. This includes applying translations defined at both the product level and the characteristic level.

Since:

Catalog Service 2.3.0, Release Train 2.3.0

Method Summary

Modifier and Type	Method	Description
void	applyBaseCharacteristicsTranslations(Product product, ResolvedProductReferences foundItems, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Handle finding and applying translations of a CharacteristicValue defined on the base Characteristic entity
void	applyConsolidatedCharacteristicsTranslationsToProduct(Product product, ResolvedProductReferences foundItems, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Handle finding and applying translations for any ProductCharacteristic.getValue() where the ProductCharacteristicValue.getSourceCharacteristicValueId() is present.
void	applyDirectProductCharacteristicsTranslations(Product product, ResolvedProductReferences foundItems, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Handle finding and applying translations for any ProductCharacteristic.getValue() where the ProductCharacteristicValue.getSourceCharacteristicValueId() is present.
void	findTranslationsForProductsCharacteristics(ProductReferences references, ResolvedProductReferences resolved, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Finds the translations for the products characteristic values and characteristic values translations.

Method Details

applyConsolidatedCharacteristicsTranslationsToProduct

void applyConsolidatedCharacteristicsTranslationsToProduct(Product product,
 ResolvedProductReferences foundItems,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Handle finding and applying translations for any ProductCharacteristic.getValue() where the ProductCharacteristicValue.getSourceCharacteristicValueId() is present. If there is a translation directly defined under the Product for its ProductCharacteristic elements, then they will be used with higher priority. As a fallback, if there is a CharacteristicValue translation defined on the base Characteristic entity, it will be applied.

Parameters:

product - The product instance with its characteristics already hydrated

foundItems - the pre-fetched data that should be used for hydration. At a minimum, this must include: ResolvedProductReferences.getCharacteristicValueTranslationsByCharacteristicId() (for all the product characteristics), ResolvedProductReferences.getProductCharacteristicTranslationsByProductId() (for all the product's product characteristics)

contextInfo - context surrounding sandboxing and multitenant state

applyDirectProductCharacteristicsTranslations

void applyDirectProductCharacteristicsTranslations(Product product,
 ResolvedProductReferences foundItems,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Handle finding and applying translations for any ProductCharacteristic.getValue() where the ProductCharacteristicValue.getSourceCharacteristicValueId() is present.

Parameters:

product - The product instance with its characteristics already hydrated

foundItems - the pre-fetched data that should be used for hydration. At a minimum, this must include: ResolvedProductReferences.getProductCharacteristicTranslationsByProductId() (for all the product's product characteristics)

contextInfo - context surrounding sandboxing and multitenant state

applyBaseCharacteristicsTranslations

void applyBaseCharacteristicsTranslations(Product product,
 ResolvedProductReferences foundItems,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Handle finding and applying translations of a CharacteristicValue defined on the base Characteristic entity

Parameters:

product - The product instance with its characteristics already hydrated

foundItems - the pre-fetched data that should be used for hydration. At a minimum, this must include: ResolvedProductReferences.getCharacteristicValueTranslationsByCharacteristicId() (for all the products characteristics)

contextInfo - context surrounding sandboxing and multitenant state

findTranslationsForProductsCharacteristics

void findTranslationsForProductsCharacteristics(ProductReferences references,
 ResolvedProductReferences resolved,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Finds the translations for the products characteristic values and characteristic values translations. This method populates ResolvedProductReferences.getCharacteristicValueTranslationsByCharacteristicId() and ResolvedProductReferences.getProductCharacteristicTranslationsByProductId()

Parameters:

references - the product references containing the ProductReferences.getProductIdsToFindProductCharacteristicsFor() productIds to find characteristics for

resolved - the resolved product references to populate, also need to contain ResolvedProductReferences.getProductCharacteristicsByProductId()

contextInfo - context information surrounding sandboxing and multitenant state