Class Augmentation
- java.lang.Object
-
- com.broadleafcommerce.metadata.core.domain.Augmentation
-
- All Implemented Interfaces:
Serializable
public class Augmentation extends Object implements Serializable
- Author:
- Nick Crum ncrum
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Augmentation()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected booleancanEqual(Object other)booleanequals(Object o)AugmentationChangeTypegetChangeType()The type of change this represents.StringgetComponentClassifier()The classifier of the component.StringgetComponentType()The type of the component.StringgetContainerKey()Reference to the top-levelComponent.getAugmentationKey()in the root-level componentStringgetId()StringgetJsonPayload()The json representation of the component for this augmentation operation.StringgetTargetKey()The augmentation key of the child within the container that is the target of the augmentcom.broadleafcommerce.metadata.i18n.InternationalizedMessagegetTargetLabel()This is the label of the target component and is NOT persisted with the augmentation.InstantgetTimestamp()The timestamp of when this was created.inthashCode()voidsetChangeType(AugmentationChangeType changeType)The type of change this represents.voidsetComponentClassifier(String componentClassifier)The classifier of the component.voidsetComponentType(String componentType)The type of the component.voidsetContainerKey(String containerKey)Reference to the top-levelComponent.getAugmentationKey()in the root-level componentvoidsetId(String id)voidsetJsonPayload(String jsonPayload)The json representation of the component for this augmentation operation.voidsetTargetKey(String targetKey)The augmentation key of the child within the container that is the target of the augmentvoidsetTargetLabel(com.broadleafcommerce.metadata.i18n.InternationalizedMessage targetLabel)This is the label of the target component and is NOT persisted with the augmentation.voidsetTimestamp(Instant timestamp)The timestamp of when this was created.StringtoString()
-
-
-
Method Detail
-
getId
public String getId()
-
getContainerKey
public String getContainerKey()
Reference to the top-levelComponent.getAugmentationKey()in the root-level component
-
getTargetKey
public String getTargetKey()
The augmentation key of the child within the container that is the target of the augment
-
getChangeType
public AugmentationChangeType getChangeType()
The type of change this represents.- See Also:
for the enumerated options
-
getTimestamp
public Instant getTimestamp()
The timestamp of when this was created. Used for determining the order of operations when applying augmentations.
-
getJsonPayload
public String getJsonPayload()
The json representation of the component for this augmentation operation. Only non-null whenchangeTypeisAugmentationChangeType.INSERTorAugmentationChangeType.PATCH- Returns:
- the json representation of the component for this augmentation operation
-
getComponentClassifier
public String getComponentClassifier()
The classifier of the component.- Returns:
- the classifier of the component
-
getComponentType
public String getComponentType()
The type of the component.- Returns:
- the type of the component
-
getTargetLabel
public com.broadleafcommerce.metadata.i18n.InternationalizedMessage getTargetLabel()
This is the label of the target component and is NOT persisted with the augmentation. It is defined at augmentation time.
-
setId
public void setId(String id)
-
setContainerKey
public void setContainerKey(String containerKey)
Reference to the top-levelComponent.getAugmentationKey()in the root-level component
-
setTargetKey
public void setTargetKey(String targetKey)
The augmentation key of the child within the container that is the target of the augment
-
setChangeType
public void setChangeType(AugmentationChangeType changeType)
The type of change this represents.- See Also:
for the enumerated options
-
setTimestamp
public void setTimestamp(Instant timestamp)
The timestamp of when this was created. Used for determining the order of operations when applying augmentations.
-
setJsonPayload
public void setJsonPayload(String jsonPayload)
The json representation of the component for this augmentation operation. Only non-null whenchangeTypeisAugmentationChangeType.INSERTorAugmentationChangeType.PATCH- Parameters:
jsonPayload- the json representation of the component for this augmentation operation
-
setComponentClassifier
public void setComponentClassifier(String componentClassifier)
The classifier of the component.- Parameters:
componentClassifier- the classifier of the component
-
setComponentType
public void setComponentType(String componentType)
The type of the component.- Parameters:
componentClassifier- the type of the component
-
setTargetLabel
public void setTargetLabel(com.broadleafcommerce.metadata.i18n.InternationalizedMessage targetLabel)
This is the label of the target component and is NOT persisted with the augmentation. It is defined at augmentation time.
-
canEqual
protected boolean canEqual(Object other)
-
-