Package com.broadleafcommerce.catalog.domain.asset

Class CategoryAsset

java.lang.Object
com.broadleafcommerce.asset.consumer.domain.EntityAsset
com.broadleafcommerce.catalog.domain.asset.CategoryAsset
All Implemented Interfaces:
com.broadleafcommerce.asset.consumer.domain.AssetSourceAware, PrimaryAsset, com.broadleafcommerce.data.tracking.core.ContextStateAware, com.broadleafcommerce.data.tracking.core.sort.business.domain.Sorted, Serializable
public class CategoryAsset extends com.broadleafcommerce.asset.consumer.domain.EntityAsset implements Serializable, PrimaryAsset, com.broadleafcommerce.data.tracking.core.ContextStateAware, com.broadleafcommerce.data.tracking.core.sort.business.domain.Sorted
Represents a relationship between a Category and an Asset.
Author:
Samarth Dhruva (samarthd)
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    CategoryAsset()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    String
    getCategoryId()
    The context ID of the Category associated with this asset.
    com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState
    getContextState()
    A subset of Tracking information to expose the context state for this object.
    String
    getId()
    The context ID of the relationship.
    String
    getParentId()
    The context ID of the parent entity associated with this asset.
    Boolean
    getSorted()
    Whether the persistent counterpart to this CategoryAsset has a non-default value for Sortable.getSorting(), which determines order in admin list grids and ordering of images that appear in customer-facing frontend views that are driven by CategoryAsset.
    int
    hashCode()
     
    boolean
    isPrimary()
    Determines whether this asset should be considered the primary asset for the category.
    void
    setCategoryId(String categoryId)
    The context ID of the Category associated with this asset.
    void
    setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
    A subset of Tracking information to expose the context state for this object.
    void
    setId(String id)
    The context ID of the relationship.
    void
    setPrimary(boolean primary)
    Determines whether this asset should be considered the primary asset for the category.
    void
    setSorted(Boolean sorted)
    Whether the persistent counterpart to this CategoryAsset has a non-default value for Sortable.getSorting(), which determines order in admin list grids and ordering of images that appear in customer-facing frontend views that are driven by CategoryAsset.
    String
    toString()
     

    Methods inherited from class com.broadleafcommerce.asset.consumer.domain.EntityAsset

    getAltText, getApplicationId, getEmbedCode, getProvider, getTags, getTenantId, getTitle, getType, getUrl, setAltText, setApplicationId, setEmbedCode, setProvider, setTags, setTenantId, setTitle, setType, setUrl

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • CategoryAsset

      public CategoryAsset()

  • Method Details

    • getParentId

      public String getParentId()
      Description copied from interface: PrimaryAsset
      The context ID of the parent entity associated with this asset.
      Specified by:
      getParentId in interface PrimaryAsset
      Returns:
      the context ID of the parent entity in the relationship
      See Also:

    • getId

      public String getId()
      The context ID of the relationship.
      Specified by:
      getId in interface PrimaryAsset
      Returns:
      the context ID of the relationship

    • getCategoryId

      public String getCategoryId()
      The context ID of the Category associated with this asset.
      Returns:
      the context ID of the category in the relationship

    • isPrimary

      public boolean isPrimary()
      Determines whether this asset should be considered the primary asset for the category.

      For any category, there can only be one CategoryAsset with this value set to true.

      Specified by:
      isPrimary in interface PrimaryAsset
      Returns:
      true if this asset should be the primary asset for the category, false otherwise

    • getSorted

      public Boolean getSorted()
      Whether the persistent counterpart to this CategoryAsset has a non-default value for Sortable.getSorting(), which determines order in admin list grids and ordering of images that appear in customer-facing frontend views that are driven by CategoryAsset.
      Specified by:
      getSorted in interface com.broadleafcommerce.data.tracking.core.sort.business.domain.Sorted
      Returns:
      Whether the persistent counterpart to this CategoryAsset has a non-default value for Sortable.getSorting().
      See Also:
      • Sorted.getSorted()
      • Sortable

    • getContextState

      public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Returns:
      a subset of Tracking information to expose the context state for this object

    • setId

      public void setId(String id)
      The context ID of the relationship.
      Parameters:
      id - the context ID of the relationship

    • setCategoryId

      public void setCategoryId(String categoryId)
      The context ID of the Category associated with this asset.
      Parameters:
      categoryId - the context ID of the category in the relationship

    • setPrimary

      public void setPrimary(boolean primary)
      Determines whether this asset should be considered the primary asset for the category.

      For any category, there can only be one CategoryAsset with this value set to true.

      Specified by:
      setPrimary in interface PrimaryAsset
      Parameters:
      primary - true if this asset should be the primary asset for the category, false otherwise

    • setSorted

      public void setSorted(Boolean sorted)
      Whether the persistent counterpart to this CategoryAsset has a non-default value for Sortable.getSorting(), which determines order in admin list grids and ordering of images that appear in customer-facing frontend views that are driven by CategoryAsset.
      Parameters:
      sorted - Whether the persistent counterpart to this CategoryAsset has a non-default value for Sortable.getSorting().
      See Also:
      • Sorted.getSorted()
      • Sortable

    • setContextState

      public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Parameters:
      contextState - a subset of Tracking information to expose the context state for this object

    • toString

      public String toString()
      Overrides:
      toString in class com.broadleafcommerce.asset.consumer.domain.EntityAsset

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class com.broadleafcommerce.asset.consumer.domain.EntityAsset

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class com.broadleafcommerce.asset.consumer.domain.EntityAsset

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class com.broadleafcommerce.asset.consumer.domain.EntityAsset