Package com.broadleafcommerce.cart.client.domain

Class ItemListAccessRule

java.lang.Object
com.broadleafcommerce.cart.client.domain.ItemListAccessRule
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable
public class ItemListAccessRule extends Object implements Serializable, com.broadleafcommerce.data.tracking.core.ContextStateAware
A rule allowing access to an item list.
Author:
Jacob Mitash
See Also:

  • Constructor Details

    • ItemListAccessRule

      public ItemListAccessRule()

  • Method Details

    • getId

      public String getId()
      The ID of this item list access rule.
      Returns:
      the ID of this item list access rule

    • getItemListId

      public String getItemListId()
      The ID of the item list this rule provides access to.
      Returns:
      the name of the corresponding item list

    • getType

      public String getType()
      The type of this access rule. Describes what is contained in the value property and is used in performing the actual access validation. See DefaultItemListAccessRuleType for out of box values.
      Returns:
      the type of this access rule

    • getRole

      public String getRole()
      The role this rule is allowing. Describes how (in terms of what level of access) the item list may be accessed. See DefaultItemListAccessRuleRole for out of box values.
      Returns:
      the role this access rule is allowing

    • getValue

      public String getValue()
      Some value of the type of this access rule. For example, if the type is an email address, the value should contain an email address of the user being allowed access to the list.
      Returns:
      the value of this access rule

    • 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 ID of this item list access rule.
      Parameters:
      id - the ID of this item list access rule

    • setItemListId

      public void setItemListId(String itemListId)
      The ID of the item list this rule provides access to.
      Parameters:
      itemListId - the ID of the corresponding item list

    • setType

      public void setType(String type)
      The type of this access rule. Describes what is contained in the value property and is used in performing the actual access validation. See DefaultItemListAccessRuleType for out of box values.
      Parameters:
      type - the type of this access rule

    • setRole

      public void setRole(String role)
      The role this rule is allowing. Describes how (in terms of what level of access) the item list may be accessed. See DefaultItemListAccessRuleRole for out of box values.
      Parameters:
      role - the role this access rule is allowing

    • setValue

      public void setValue(String value)
      Some value of the type of this access rule. For example, if the type is an email address, the value should contain an email address of the user being allowed access to the list.
      Parameters:
      value - the value of this access rule

    • 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

    • 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