Package com.broadleafcommerce.dataexchange.domain

Class AbstractExchangeObject

java.lang.Object
com.broadleafcommerce.dataexchange.domain.AbstractExchangeObject
All Implemented Interfaces:
ExchangeObject, Serializable
Direct Known Subclasses:
Attribute, EntityExchangeObject, Prices, Translation
public abstract class AbstractExchangeObject extends Object implements Serializable, ExchangeObject
Parent class that contains correlation Ids to re-create the structure. If this represents an entity with a database ID, use EntityExchangeObject instead.

The intention for this is to be used on any entities that will be passed to APIs for persistence or perhaps a class containing a group of entities.

If the class is just a property of an entity, this is unneeded. NOTE: If the previous statement is true, re-consider if you need to define a class at all. This service just passes data through as-is without needing to explicitly define every property on an entity. Unless you need to perform some kind of action using the data, you do not need to define a class. If you need a custom complex data structure, it is recommended that you extend an existing entity and define the relationship there rather than use the getCustomProperties(), which makes use of @JsonAnyGetter and JsonAnySetter.

See Also:

  • Constructor Details

    • AbstractExchangeObject

      public AbstractExchangeObject()

  • Method Details

    • setCustomProperty

      public void setCustomProperty(String key, Object value)

    • getCustomProperties

      public Map<String,Object> getCustomProperties()

    • getParentCorrelationId

      public String getParentCorrelationId()
      Specified by:
      getParentCorrelationId in interface ExchangeObject

    • getCorrelationId

      public String getCorrelationId()
      Specified by:
      getCorrelationId in interface ExchangeObject

    • isNewlyCreated

      public boolean isNewlyCreated()
      Specified by:
      isNewlyCreated in interface ExchangeObject
      Returns:
      true if the object is newly created. Note that this is not always applicable to all objects.

    • setParentCorrelationId

      public void setParentCorrelationId(String parentCorrelationId)
      Specified by:
      setParentCorrelationId in interface ExchangeObject

    • setCorrelationId

      public void setCorrelationId(String correlationId)
      Specified by:
      setCorrelationId in interface ExchangeObject

    • setCustomProperties

      public void setCustomProperties(Map<String,Object> customProperties)
      Any custom properties from extensions that should just be passed through.

    • setNewlyCreated

      public void setNewlyCreated(boolean newlyCreated)
      Description copied from interface: ExchangeObject
      Set to true if the object is newly created. This may not be applicable to all objects.
      Specified by:
      setNewlyCreated in interface ExchangeObject
      Parameters:
      newlyCreated - true if the object is newly created

    • 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