Package com.broadleafcommerce.data.tracking.core.filtering.domain

Interface ChangeContainer

  • All Known Implementing Classes:
    ContextChangeContainer
    public interface ChangeContainer
    Container information for a change, used for grouping separate change information under the same top-level entity.
    Author:
    Chad Harchar (charchar)

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default String getContainerCatalog()
      If the container is catalog discriminated and this instance is a subcontainer, the catalog context id for the container.
      String getId()
      Generally, the context id of the top-level entity that changed
      String getName()
      The name of the top-level entity that changed, which is typically snake-cased and capitalized, i.e., "PRODUCT".
      String getRouteKey()  
      String getSubContainerName()
      The name of the sub-container (second-level entity), which is typically snake-cased and capitalized i.e., "PRICE_DATA".
      default void setContainerCatalog​(String containerCatalog)
      If the container is catalog discriminated and this instance is a subcontainer, the catalog context id for the container.
      void setId​(String id)
      Generally, the context id of the top-level entity that changed
      void setName​(String name)
      The name of the top-level entity that changed, which is typically snake-cased and capitalized, i.e., "PRODUCT".
      void setRouteKey​(String routeKey)  
      void setSubContainerName​(String subContainerName)
      The name of the sub-container (second-level entity), which is typically snake-cased and capitalized i.e., "PRICE_DATA".

    • Method Detail

      • getId

        String getId()
        Generally, the context id of the top-level entity that changed
        Returns:
        Generally, the context id of the top-level entity that changed
        See Also:
        Trackable.getContextId()

      • setId

        void setId​(String id)
        Generally, the context id of the top-level entity that changed
        Parameters:
        id - Generally, the context id of the top-level entity that changed
        See Also:
        Trackable.getContextId()

      • getName

        String getName()
        The name of the top-level entity that changed, which is typically snake-cased and capitalized, i.e., "PRODUCT".
        Returns:
        The name of the top-level entity that changed, which is typically snake-cased and capitalized, i.e., "PRODUCT"

      • setName

        void setName​(String name)
        The name of the top-level entity that changed, which is typically snake-cased and capitalized, i.e., "PRODUCT".
        Parameters:
        name - The name of the top-level entity that changed, which is typically snake-cased and capitalized, i.e., "PRODUCT"

      • getRouteKey

        String getRouteKey()

      • setRouteKey

        void setRouteKey​(String routeKey)

      • getSubContainerName

        String getSubContainerName()
        The name of the sub-container (second-level entity), which is typically snake-cased and capitalized i.e., "PRICE_DATA".
        Returns:
        The name of the sub-container (second-level entity), which is typically snake-cased and capitalized, i.e., "PRICE_DATA"

      • setSubContainerName

        void setSubContainerName​(String subContainerName)
        The name of the sub-container (second-level entity), which is typically snake-cased and capitalized i.e., "PRICE_DATA".
        Parameters:
        subContainerName - The name of the sub-container (second-level entity), which is typically snake-cased and capitalized, i.e., "PRICE_DATA"

      • getContainerCatalog

        default String getContainerCatalog()
        If the container is catalog discriminated and this instance is a subcontainer, the catalog context id for the container.
        Returns:
        The catalog context id for the container.

      • setContainerCatalog

        default void setContainerCatalog​(String containerCatalog)
        If the container is catalog discriminated and this instance is a subcontainer, the catalog context id for the container.
        Parameters:
        containerCatalog - The catalog context id for the container.