Package com.broadleafcommerce.catalog.domain.product.characteristic

Class ProductCharacteristicValue

java.lang.Object

com.broadleafcommerce.catalog.domain.product.characteristic.ProductCharacteristicValue

All Implemented Interfaces:

Serializable

public class ProductCharacteristicValue
extends Object
implements Serializable

Links a ProductCharacteristicValue to a CharacteristicValue primarily for syncing translations between the domains.

Since:

Catalog Service 2.2.0, Release Train 2.2.0

Author:

Julia Lopez-Pozas (jlopezpozas)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ProductCharacteristicValue()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Map<String,Object>	getAttributes()	Additional custom attributes associated with extensions and complex value types, e.g., enum, variant option.
String	getLabel()	The label of the characteristic value.
String	getSourceCharacteristicValueId()	The source CharacteristicValue.getId() that this current value is derived from, if any.
Object	getValue()	The value of the characteristic for this product.
String	getValueType()	The type of this value, e.g., enum, string, etc.
int	hashCode()
boolean	isActive()	Determines if this value is active.
boolean	isDefault()	Determines if this value is the default value for the characteristic.
void	setActive(boolean isActive)	Determines if this value is active.
void	setAttributes(Map<String,Object> attributes)	Additional custom attributes associated with extensions and complex value types, e.g., enum, variant option.
void	setDefault(boolean isDefault)	Determines if this value is the default value for the characteristic.
void	setLabel(String label)	The label of the characteristic value.
void	setSourceCharacteristicValueId(String sourceCharacteristicValueId)	The source CharacteristicValue.getId() that this current value is derived from, if any.
void	setValue(Object value)	The value of the characteristic for this product.
void	setValueType(String valueType)	The type of this value, e.g., enum, string, etc.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ProductCharacteristicValue

public ProductCharacteristicValue()

Method Details

getSourceCharacteristicValueId

@Nullable
public String getSourceCharacteristicValueId()

The source CharacteristicValue.getId() that this current value is derived from, if any.

It's possible that when a Product is first created, it may not have any Product.getCharacteristics() associated to it. Alternatively, it's possible that after a Product is created and has already been assigned Product.getCharacteristics(), the parent BusinessType.getCharacteristics() may change, and therefore the Product.getCharacteristics() may be outdated/missing values.

In such cases, it is often preferable for the API caller to engage a synchronization process. Part of this process ensures that for any ProductCharacteristic which does not have any values set, the values will be initialized with ProductCharacteristicValue instances copied from the base values. Because these values are copied directly from the base CharacteristicValue, we want to also ensure that any translations for the base CharacteristicValue are applied to the ProductCharacteristicValue replica. The mechanism to achieve this is in DefaultCharacteristicsTranslationService, where any translations tied to CharacteristicValue.getId() are mapped to the ProductCharacteristicValue, and the connection between the two is handled via getSourceCharacteristicValueId(). Note that if a translation is specified directly for the ProductCharacteristicValue instance, it will take precedence over any translation from the base CharacteristicValue.

Thus, this getSourceCharacteristicValueId() field is primarily relevant for scenarios where the ProductCharacteristicValue is directly copied from a value set in the base CharacteristicValue, and should also inherit translations from that base value. In a scenario where the ProductCharacteristicValue is independently created, or overridden/changed from the base CharacteristicValue, getSourceCharacteristicValueId() naturally does not have much importance, as the translations from the base value will not be applicable to this 'custom-defined' value.

As a result, when possible, API callers should prefer to provide the CharacteristicValue.getId() in this field if this value exactly matches the base value, and you are intending to inherit its translations. Otherwise, it can be left null, in which case this ProductCharacteristicValue will be disconnected from any CharacteristicValue, and not participate in any translation inheritance.

getValue

public Object getValue()

The value of the characteristic for this product.

getLabel

public String getLabel()

The label of the characteristic value.

getValueType

public String getValueType()

The type of this value, e.g., enum, string, etc.

isDefault

public boolean isDefault()

Determines if this value is the default value for the characteristic.

Since:

Catalog Service 2.2.1, Release Train 2.2.1

isActive

public boolean isActive()

Determines if this value is active.

Since:

Catalog Service 2.2.1, Release Train 2.2.1

getAttributes

public Map<String,Object> getAttributes()

Additional custom attributes associated with extensions and complex value types, e.g., enum, variant option.

Since:

Catalog Services 2.3.0, Release Train 2.3.0

setSourceCharacteristicValueId

public void setSourceCharacteristicValueId(@Nullable
 String sourceCharacteristicValueId)

The source CharacteristicValue.getId() that this current value is derived from, if any.

It's possible that when a Product is first created, it may not have any Product.getCharacteristics() associated to it. Alternatively, it's possible that after a Product is created and has already been assigned Product.getCharacteristics(), the parent BusinessType.getCharacteristics() may change, and therefore the Product.getCharacteristics() may be outdated/missing values.

In such cases, it is often preferable for the API caller to engage a synchronization process. Part of this process ensures that for any ProductCharacteristic which does not have any values set, the values will be initialized with ProductCharacteristicValue instances copied from the base values. Because these values are copied directly from the base CharacteristicValue, we want to also ensure that any translations for the base CharacteristicValue are applied to the ProductCharacteristicValue replica. The mechanism to achieve this is in DefaultCharacteristicsTranslationService, where any translations tied to CharacteristicValue.getId() are mapped to the ProductCharacteristicValue, and the connection between the two is handled via getSourceCharacteristicValueId(). Note that if a translation is specified directly for the ProductCharacteristicValue instance, it will take precedence over any translation from the base CharacteristicValue.

Thus, this getSourceCharacteristicValueId() field is primarily relevant for scenarios where the ProductCharacteristicValue is directly copied from a value set in the base CharacteristicValue, and should also inherit translations from that base value. In a scenario where the ProductCharacteristicValue is independently created, or overridden/changed from the base CharacteristicValue, getSourceCharacteristicValueId() naturally does not have much importance, as the translations from the base value will not be applicable to this 'custom-defined' value.

As a result, when possible, API callers should prefer to provide the CharacteristicValue.getId() in this field if this value exactly matches the base value, and you are intending to inherit its translations. Otherwise, it can be left null, in which case this ProductCharacteristicValue will be disconnected from any CharacteristicValue, and not participate in any translation inheritance.

setValue

public void setValue(Object value)

The value of the characteristic for this product.

setLabel

public void setLabel(String label)

The label of the characteristic value.

setValueType

public void setValueType(String valueType)

The type of this value, e.g., enum, string, etc.

setDefault

public void setDefault(boolean isDefault)

Determines if this value is the default value for the characteristic.

Since:

Catalog Service 2.2.1, Release Train 2.2.1

setActive

public void setActive(boolean isActive)

Determines if this value is active.

Since:

Catalog Service 2.2.1, Release Train 2.2.1

setAttributes

public void setAttributes(Map<String,Object> attributes)

Additional custom attributes associated with extensions and complex value types, e.g., enum, variant option.

Since:

Catalog Services 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