Class ContentZoneItemList

java.lang.Object
com.broadleafcommerce.content.domain.ContentZoneItemList
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.EmbeddedContextStateAware, com.broadleafcommerce.translation.mapping.SubIdentifiable, Serializable

public class ContentZoneItemList extends Object implements Serializable, com.broadleafcommerce.data.tracking.core.EmbeddedContextStateAware, com.broadleafcommerce.translation.mapping.SubIdentifiable
Represents a collection of ContentZoneItems related to a ContentZone that should be returned together when the displayRule matches the request context.
Author:
Nathan Moore (nathandmoore)
See Also:
  • Constructor Details

    • ContentZoneItemList

      public ContentZoneItemList()
  • Method Details

    • getItems

      public List<ContentZoneItem> getItems()
      The ContentItems in this list.
      Returns:
      The ContentItems in this list.
    • getId

      public String getId()
      The id for this list. Should be unique for the parent ContentZone.
      Specified by:
      getId in interface com.broadleafcommerce.translation.mapping.SubIdentifiable
      Returns:
      The id for this list.
    • getName

      public String getName()
      The name of this list. This is used in the admin UI.
      Returns:
      The name of this list.
    • getDisplayRule

      public String getDisplayRule()
      The display rule required to be matched by requests for the list to be displayed in the zone.
      Returns:
      The display rule required to be matched by requests for the list to be displayed in the zone.
    • getContextState

      public com.broadleafcommerce.data.tracking.core.EmbeddedContextState getContextState()
      A subset of Tracking information to expose the context state for this object. This value is not persisted, and instead it is dynamically calculated and populated when the ChangeDetails for the parent object's entire attributes map are compared.
      Specified by:
      getContextState in interface com.broadleafcommerce.data.tracking.core.EmbeddedContextStateAware
      Returns:
      a subset of Tracking information to expose the context state for this object
    • setItems

      public void setItems(List<ContentZoneItem> items)
      The ContentItems in this list.
      Parameters:
      items - The ContentItems in this list.
    • setId

      public void setId(String id)
      The id for this list. Should be unique for the parent ContentZone.
      Specified by:
      setId in interface com.broadleafcommerce.translation.mapping.SubIdentifiable
      Parameters:
      id - The id for this list.
    • setName

      public void setName(String name)
      The name of this list. This is used in the admin UI.
      Parameters:
      name - The name of this list.
    • setDisplayRule

      public void setDisplayRule(String displayRule)
      The display rule required to be matched by requests for the list to be displayed in the zone.
      Parameters:
      displayRule - The display rule required to be matched by requests for the list to be displayed in the zone.
    • setContextState

      public void setContextState(com.broadleafcommerce.data.tracking.core.EmbeddedContextState contextState)
      A subset of Tracking information to expose the context state for this object. This value is not persisted, and instead it is dynamically calculated and populated when the ChangeDetails for the parent object's entire attributes map are compared.
      Specified by:
      setContextState in interface com.broadleafcommerce.data.tracking.core.EmbeddedContextStateAware
      Parameters:
      contextState - a subset of Tracking information to expose the context state for this object
    • 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