Class Customer

  • All Implemented Interfaces:
    com.broadleafcommerce.data.tracking.core.ContextStateAware, com.broadleafcommerce.search.api.domain.Indexable<String>

    public class Customer
    extends Object
    implements com.broadleafcommerce.search.api.domain.Indexable<String>, com.broadleafcommerce.data.tracking.core.ContextStateAware
    The indexable customer payload received from the web request for retrieving customers, to be mapped into a document for the search engine.
    • Constructor Detail

      • Customer

        public Customer()
    • Method Detail

      • getType

        public final com.broadleafcommerce.search.api.type.IndexableType getType()
        Specified by:
        getType in interface com.broadleafcommerce.search.api.domain.Indexable<String>
      • getTranslations

        public List<com.broadleafcommerce.search.api.domain.translation.Translation> getTranslations()
        Customers are not translatable, so no translations are provided.
        Specified by:
        getTranslations in interface com.broadleafcommerce.search.api.domain.Indexable<String>
        Returns:
        empty list
      • addAttribute

        public void addAttribute​(String name,
                                 Object value)
        Add a value to the JSON data. Necessary for populating the JSON from the payload.
        Parameters:
        name - the attribute name
        value - the attribute value
      • getAttribute

        public Object getAttribute​(String name)
        Get a value from the JSON data. Necessary for populating the JSON from the payload.
        Parameters:
        name - the attribute name
      • getJsonMap

        public Map<String,​Object> getJsonMap()
        JSON data for the customer object which isn't already stored in other fields.
        Specified by:
        getJsonMap in interface com.broadleafcommerce.search.api.domain.Indexable<String>
        Returns:
        JSON customer object data
      • getId

        public String getId()
        The context ID of the customer.
        Specified by:
        getId in interface com.broadleafcommerce.search.api.domain.Indexable<String>
        Returns:
        the context ID of the customer
      • getContextState

        public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
        Trackable context state information for this customer.
        Specified by:
        getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
        Returns:
        trackable context state information
      • setJsonMap

        public void setJsonMap​(Map<String,​Object> jsonMap)
        JSON data for the customer object which isn't already stored in other fields.
        Parameters:
        jsonMap - JSON customer object data
      • setId

        public void setId​(String id)
        The context ID of the customer.
        Parameters:
        id - the context ID of the customer
      • setContextState

        public void setContextState​(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
        Trackable context state information for this customer.
        Specified by:
        setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
        Parameters:
        contextState - trackable context state information
      • canEqual

        protected boolean canEqual​(Object other)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object