Interface ExchangeObject
- All Known Implementing Classes:
AbstractExchangeObject,Attribute,CategoryRef,ComprehensiveProduct,DataDrivenEnum,DefaultBatchItemErrorHandler.ErrorExchangeObject,EntityExchangeObject,ExchangeEntityAsset,Prices,ProductAsset,ProductOption,ProductTag,SkuInventory,Translation,Variant
public interface ExchangeObject
Parent class that contains correlation Ids to re-create the structure
- Author:
- Kelly Tisdell (ktisdell)
-
Method Summary
Modifier and TypeMethodDescriptiondefault com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextStatedefault StringgetId()booleandefault voidsetContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState) voidsetCorrelationId(String correlationId) default voidSet the id of the entityvoidsetJsonPath(String jsonPath) voidsetNewlyCreated(boolean newlyCreated) Set to true if the object is newly created.voidsetParentCorrelationId(String parentCorrelationId)
-
Method Details
-
getId
- Returns:
- the id of the entity
-
setId
Set the id of the entity- Parameters:
id- the id of the entity
-
getParentCorrelationId
String getParentCorrelationId() -
setParentCorrelationId
-
getCorrelationId
String getCorrelationId() -
setCorrelationId
-
getContextState
@Nullable default com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState() -
setContextState
default void setContextState(@Nullable com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState) -
setNewlyCreated
void setNewlyCreated(boolean newlyCreated) Set to true if the object is newly created. This may not be applicable to all objects.- Parameters:
newlyCreated- true if the object is newly created
-
isNewlyCreated
boolean isNewlyCreated()- Returns:
- true if the object is newly created. Note that this is not always applicable to all objects.
-
setJsonPath
-
getJsonPath
String getJsonPath()
-