Package com.broadleafcommerce.data.tracking.core

Interface ContextStateAware

All Known Implementing Classes:
Application, Catalog, MarketplaceApplicationCatalog
public interface ContextStateAware

Defines additional information for the business domain that describes aspects of the entity related to the context of the request. For example, field override and mutability information.

A business domain's ContextState is only populated when coming out of the repository domain that maps into a business domain. This is not designed to be used in other scenarios.

Indicating that your object should receive a context is as simple as implementing this interface for any business-domain equivalent of a repository domain that implements Tracking. If you have any resident collections (collections whose tracking is owned solely by a parent) you can annotate those with ContextStateAware as well.

Author:
Jeff Fischer
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    ContextState
    getContextState()
    Retrieve additional information for the business domain that describes aspects of the entity related to the context of the request
    void
    setContextState(ContextState contextState)
    Set additional information for the business domain that describes aspects of the entity related to the context of the request

  • Method Details

    • getContextState

      ContextState getContextState()
      Retrieve additional information for the business domain that describes aspects of the entity related to the context of the request
      Returns:
      additional information for the business domain that describes aspects of the entity related to the context of the request

    • setContextState

      void setContextState(ContextState contextState)
      Set additional information for the business domain that describes aspects of the entity related to the context of the request
      Parameters:
      contextState - additional information for the business domain that describes aspects of the entity related to the context of the request