Package com.broadleafcommerce.catalog.domain.product

Class ProductTerm

java.lang.Object
com.broadleafcommerce.catalog.domain.product.ProductTerm
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.EmbeddedContextStateAware, com.broadleafcommerce.translation.mapping.SubIdentifiable, Serializable
public class ProductTerm extends Object implements Serializable, com.broadleafcommerce.translation.mapping.SubIdentifiable, com.broadleafcommerce.data.tracking.core.EmbeddedContextStateAware
Represents a configurable contract term for a Product. Terms are useful for configuring different prices depending on the length of the term. The default term is used for the initial display price.
Since:
Catalog Service 2.2.0, Release Train 2.2.0
See Also:

  • Field Summary

    Fields inherited from interface com.broadleafcommerce.data.tracking.core.EmbeddedContextStateAware

    DEFAULT_FIELD_NAME

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProductTerm()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    Boolean
    getAllowEndOfTermStrategyModification()
    This flag indicates whether this subscription's endOfTermStrategy can be modified after declaration on the subscription.
    com.broadleafcommerce.data.tracking.core.EmbeddedContextState
    getContextState()
    A subset of Tracking information to expose the context state for this object.
    int
    getDurationLength()
    Time interval (number of seconds, minutes, hours, etc.)
    String
    getDurationType()
    The type of time interval (seconds, minutes, hours, etc.)
    String
    getEndOfTermStrategy()
    Indicates the action to be performed at the end of term.
    String
    getId()
    Identifier used for tracking purposes, primarily related to keeping track of which translations belong to which value in the list.
    String
    getName()
    A display name for the term
    int
    hashCode()
     
    boolean
    isDefault()
    Whether this term is the default term for the product
    void
    setAllowEndOfTermStrategyModification(Boolean allowEndOfTermStrategyModification)
    This flag indicates whether this subscription's endOfTermStrategy can be modified after declaration on the subscription.
    void
    setContextState(com.broadleafcommerce.data.tracking.core.EmbeddedContextState contextState)
    A subset of Tracking information to expose the context state for this object.
    void
    setDefault(boolean isDefault)
    Whether this term is the default term for the product
    void
    setDurationLength(int durationLength)
    Time interval (number of seconds, minutes, hours, etc.)
    void
    setDurationType(String durationType)
    The type of time interval (seconds, minutes, hours, etc.)
    void
    setEndOfTermStrategy(String endOfTermStrategy)
    Indicates the action to be performed at the end of term.
    void
    setId(String id)
    Identifier used for tracking purposes, primarily related to keeping track of which translations belong to which value in the list.
    void
    setName(String name)
    A display name for the term
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ProductTerm

      public ProductTerm()

  • Method Details

    • getId

      public String getId()
      Identifier used for tracking purposes, primarily related to keeping track of which translations belong to which value in the list.
      Specified by:
      getId in interface com.broadleafcommerce.translation.mapping.SubIdentifiable

    • getName

      public String getName()
      A display name for the term

    • getDurationLength

      public int getDurationLength()
      Time interval (number of seconds, minutes, hours, etc.)

    • getDurationType

      public String getDurationType()
      The type of time interval (seconds, minutes, hours, etc.)

    • isDefault

      public boolean isDefault()
      Whether this term is the default term for the product

    • getEndOfTermStrategy

      public String getEndOfTermStrategy()
      Indicates the action to be performed at the end of term.
      Since:
      Catalog Services 2.3.0, Release Train 2.3.0

    • getAllowEndOfTermStrategyModification

      public Boolean getAllowEndOfTermStrategyModification()
      This flag indicates whether this subscription's endOfTermStrategy can be modified after declaration on the subscription.
      Since:
      Catalog Services 2.3.0, Release Train 2.3.0

    • getContextState

      public com.broadleafcommerce.data.tracking.core.EmbeddedContextState getContextState()
      A subset of Tracking information to expose the context state for this object.
      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

    • setId

      public void setId(String id)
      Identifier used for tracking purposes, primarily related to keeping track of which translations belong to which value in the list.
      Specified by:
      setId in interface com.broadleafcommerce.translation.mapping.SubIdentifiable

    • setName

      public void setName(String name)
      A display name for the term

    • setDurationLength

      public void setDurationLength(int durationLength)
      Time interval (number of seconds, minutes, hours, etc.)

    • setDurationType

      public void setDurationType(String durationType)
      The type of time interval (seconds, minutes, hours, etc.)

    • setDefault

      public void setDefault(boolean isDefault)
      Whether this term is the default term for the product

    • setEndOfTermStrategy

      public void setEndOfTermStrategy(String endOfTermStrategy)
      Indicates the action to be performed at the end of term.
      Since:
      Catalog Services 2.3.0, Release Train 2.3.0

    • setAllowEndOfTermStrategyModification

      public void setAllowEndOfTermStrategyModification(Boolean allowEndOfTermStrategyModification)
      This flag indicates whether this subscription's endOfTermStrategy can be modified after declaration on the subscription.
      Since:
      Catalog Services 2.3.0, Release Train 2.3.0

    • setContextState

      public void setContextState(com.broadleafcommerce.data.tracking.core.EmbeddedContextState contextState)
      A subset of Tracking information to expose the context state for this object.
      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