Package de.hybris.platform.promotions.model

Class AbstractPromotionModel

    • Nested Class Summary

      • Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

        de.hybris.platform.servicelayer.model.AbstractItemModel.NewModelContextFactory

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _PROMOTIONGROUPPROMOTIONSRELATION
      Generated relation code constant for relation PromotionGroupPromotionsRelation defining source attribute PromotionGroup in extension promotions.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String CODE
      Generated constant - Attribute key of AbstractPromotion.code attribute defined at extension promotions.
      static java.lang.String DESCRIPTION
      Generated constant - Attribute key of AbstractPromotion.description attribute defined at extension promotions.
      static java.lang.String DETAILSURL
      Generated constant - Attribute key of AbstractPromotion.detailsURL attribute defined at extension promotions.
      static java.lang.String ENABLED
      Generated constant - Attribute key of AbstractPromotion.enabled attribute defined at extension promotions.
      static java.lang.String ENDDATE
      Generated constant - Attribute key of AbstractPromotion.endDate attribute defined at extension promotions.
      static java.lang.String IMMUTABLEKEY
      Generated constant - Attribute key of AbstractPromotion.immutableKey attribute defined at extension promotions.
      static java.lang.String IMMUTABLEKEYHASH
      Generated constant - Attribute key of AbstractPromotion.immutableKeyHash attribute defined at extension promotions.
      static java.lang.String NAME
      Generated constant - Attribute key of AbstractPromotion.name attribute defined at extension acceleratorservices.
      static java.lang.String PRIORITY
      Generated constant - Attribute key of AbstractPromotion.priority attribute defined at extension promotions.
      static java.lang.String PROMOTIONGROUP
      Generated constant - Attribute key of AbstractPromotion.PromotionGroup attribute defined at extension promotions.
      static java.lang.String PROMOTIONTYPE
      Generated constant - Attribute key of AbstractPromotion.promotionType attribute defined at extension promotions.
      static java.lang.String RESTRICTIONS
      Generated constant - Attribute key of AbstractPromotion.restrictions attribute defined at extension promotions.
      static java.lang.String STARTDATE
      Generated constant - Attribute key of AbstractPromotion.startDate attribute defined at extension promotions.
      static java.lang.String TITLE
      Generated constant - Attribute key of AbstractPromotion.title attribute defined at extension promotions.

      • Fields inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

        LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractPromotionModel()
      Generated constructor - Default constructor for generic creation.
      AbstractPromotionModel​(de.hybris.platform.servicelayer.model.ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      AbstractPromotionModel​(java.lang.String _code)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      AbstractPromotionModel​(java.lang.String _code, ItemModel _owner)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCode()
      Generated method - Getter of the AbstractPromotion.code attribute defined at extension promotions.
      java.lang.String getDescription()
      Generated method - Getter of the AbstractPromotion.description attribute defined at extension promotions.
      java.lang.String getDetailsURL()
      Generated method - Getter of the AbstractPromotion.detailsURL attribute defined at extension promotions.
      java.lang.Boolean getEnabled()
      Generated method - Getter of the AbstractPromotion.enabled attribute defined at extension promotions.
      java.util.Date getEndDate()
      Generated method - Getter of the AbstractPromotion.endDate attribute defined at extension promotions.
      java.lang.String getImmutableKey()
      Generated method - Getter of the AbstractPromotion.immutableKey attribute defined at extension promotions.
      java.lang.String getImmutableKeyHash()
      Generated method - Getter of the AbstractPromotion.immutableKeyHash attribute defined at extension promotions.
      java.lang.String getName()
      Generated method - Getter of the AbstractPromotion.name attribute defined at extension acceleratorservices.
      java.lang.String getName​(java.util.Locale loc)
      Generated method - Getter of the AbstractPromotion.name attribute defined at extension acceleratorservices.
      java.lang.Integer getPriority()
      Generated method - Getter of the AbstractPromotion.priority attribute defined at extension promotions.
      PromotionGroupModel getPromotionGroup()
      Generated method - Getter of the AbstractPromotion.PromotionGroup attribute defined at extension promotions.
      java.lang.String getPromotionType()
      Generated method - Getter of the AbstractPromotion.promotionType attribute defined at extension promotions.
      java.lang.String getPromotionType​(java.util.Locale loc)
      Generated method - Getter of the AbstractPromotion.promotionType attribute defined at extension promotions.
      java.util.Collection<AbstractPromotionRestrictionModel> getRestrictions()
      Generated method - Getter of the AbstractPromotion.restrictions attribute defined at extension promotions.
      java.util.Date getStartDate()
      Generated method - Getter of the AbstractPromotion.startDate attribute defined at extension promotions.
      java.lang.String getTitle()
      Generated method - Getter of the AbstractPromotion.title attribute defined at extension promotions.
      void setCode​(java.lang.String value)
      Generated method - Setter of AbstractPromotion.code attribute defined at extension promotions.
      void setDescription​(java.lang.String value)
      Generated method - Setter of AbstractPromotion.description attribute defined at extension promotions.
      void setDetailsURL​(java.lang.String value)
      Generated method - Setter of AbstractPromotion.detailsURL attribute defined at extension promotions.
      void setEnabled​(java.lang.Boolean value)
      Generated method - Setter of AbstractPromotion.enabled attribute defined at extension promotions.
      void setEndDate​(java.util.Date value)
      Generated method - Setter of AbstractPromotion.endDate attribute defined at extension promotions.
      void setImmutableKey​(java.lang.String value)
      Generated method - Setter of AbstractPromotion.immutableKey attribute defined at extension promotions.
      void setImmutableKeyHash​(java.lang.String value)
      Generated method - Setter of AbstractPromotion.immutableKeyHash attribute defined at extension promotions.
      void setName​(java.lang.String value)
      Generated method - Setter of AbstractPromotion.name attribute defined at extension acceleratorservices.
      void setName​(java.lang.String value, java.util.Locale loc)
      Generated method - Setter of AbstractPromotion.name attribute defined at extension acceleratorservices.
      void setPriority​(java.lang.Integer value)
      Generated method - Setter of AbstractPromotion.priority attribute defined at extension promotions.
      void setPromotionGroup​(PromotionGroupModel value)
      Generated method - Setter of AbstractPromotion.PromotionGroup attribute defined at extension promotions.
      void setRestrictions​(java.util.Collection<AbstractPromotionRestrictionModel> value)
      Generated method - Setter of AbstractPromotion.restrictions attribute defined at extension promotions.
      void setStartDate​(java.util.Date value)
      Generated method - Setter of AbstractPromotion.startDate attribute defined at extension promotions.
      void setTitle​(java.lang.String value)
      Generated method - Setter of AbstractPromotion.title attribute defined at extension promotions.

      • Methods inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

        equals, getItemModelContext, getItemtype, getPersistenceContext, getPk, getProperty, getProperty, getTenantId, hashCode, readResolve, setProperty, setProperty, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toString, writeReplace

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values

      • _PROMOTIONGROUPPROMOTIONSRELATION

        public static final java.lang.String _PROMOTIONGROUPPROMOTIONSRELATION
        Generated relation code constant for relation PromotionGroupPromotionsRelation defining source attribute PromotionGroup in extension promotions.
        See Also:
        Constant Field Values

      • PROMOTIONTYPE

        public static final java.lang.String PROMOTIONTYPE
        Generated constant - Attribute key of AbstractPromotion.promotionType attribute defined at extension promotions.
        See Also:
        Constant Field Values

      • CODE

        public static final java.lang.String CODE
        Generated constant - Attribute key of AbstractPromotion.code attribute defined at extension promotions.
        See Also:
        Constant Field Values

      • TITLE

        public static final java.lang.String TITLE
        Generated constant - Attribute key of AbstractPromotion.title attribute defined at extension promotions.
        See Also:
        Constant Field Values

      • DESCRIPTION

        public static final java.lang.String DESCRIPTION
        Generated constant - Attribute key of AbstractPromotion.description attribute defined at extension promotions.
        See Also:
        Constant Field Values

      • STARTDATE

        public static final java.lang.String STARTDATE
        Generated constant - Attribute key of AbstractPromotion.startDate attribute defined at extension promotions.
        See Also:
        Constant Field Values

      • ENDDATE

        public static final java.lang.String ENDDATE
        Generated constant - Attribute key of AbstractPromotion.endDate attribute defined at extension promotions.
        See Also:
        Constant Field Values

      • DETAILSURL

        public static final java.lang.String DETAILSURL
        Generated constant - Attribute key of AbstractPromotion.detailsURL attribute defined at extension promotions.
        See Also:
        Constant Field Values

      • RESTRICTIONS

        public static final java.lang.String RESTRICTIONS
        Generated constant - Attribute key of AbstractPromotion.restrictions attribute defined at extension promotions.
        See Also:
        Constant Field Values

      • ENABLED

        public static final java.lang.String ENABLED
        Generated constant - Attribute key of AbstractPromotion.enabled attribute defined at extension promotions.
        See Also:
        Constant Field Values

      • PRIORITY

        public static final java.lang.String PRIORITY
        Generated constant - Attribute key of AbstractPromotion.priority attribute defined at extension promotions.
        See Also:
        Constant Field Values

      • IMMUTABLEKEYHASH

        public static final java.lang.String IMMUTABLEKEYHASH
        Generated constant - Attribute key of AbstractPromotion.immutableKeyHash attribute defined at extension promotions.
        See Also:
        Constant Field Values

      • IMMUTABLEKEY

        public static final java.lang.String IMMUTABLEKEY
        Generated constant - Attribute key of AbstractPromotion.immutableKey attribute defined at extension promotions.
        See Also:
        Constant Field Values

      • PROMOTIONGROUP

        public static final java.lang.String PROMOTIONGROUP
        Generated constant - Attribute key of AbstractPromotion.PromotionGroup attribute defined at extension promotions.
        See Also:
        Constant Field Values

      • NAME

        public static final java.lang.String NAME
        Generated constant - Attribute key of AbstractPromotion.name attribute defined at extension acceleratorservices.
        See Also:
        Constant Field Values

    • Constructor Detail

      • AbstractPromotionModel

        public AbstractPromotionModel()
        Generated constructor - Default constructor for generic creation.

      • AbstractPromotionModel

        public AbstractPromotionModel​(de.hybris.platform.servicelayer.model.ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null

      • AbstractPromotionModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public AbstractPromotionModel​(java.lang.String _code)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _code - initial attribute declared by type AbstractPromotion at extension promotions

      • AbstractPromotionModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public AbstractPromotionModel​(java.lang.String _code,
                              ItemModel _owner)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _code - initial attribute declared by type AbstractPromotion at extension promotions
        _owner - initial attribute declared by type Item at extension core

    • Method Detail

      • getCode

        @Accessor(qualifier="code",
          type=GETTER)
public java.lang.String getCode()
        Generated method - Getter of the AbstractPromotion.code attribute defined at extension promotions.
        Returns:
        the code - Identifier for this promotion

      • getDescription

        @Accessor(qualifier="description",
          type=GETTER)
public java.lang.String getDescription()
        Generated method - Getter of the AbstractPromotion.description attribute defined at extension promotions.
        Returns:
        the description - Description of this promotion

      • getDetailsURL

        @Accessor(qualifier="detailsURL",
          type=GETTER)
public java.lang.String getDetailsURL()
        Generated method - Getter of the AbstractPromotion.detailsURL attribute defined at extension promotions.
        Returns:
        the detailsURL - URL to a content page with further details of this promotion

      • getEnabled

        @Accessor(qualifier="enabled",
          type=GETTER)
public java.lang.Boolean getEnabled()
        Generated method - Getter of the AbstractPromotion.enabled attribute defined at extension promotions.
        Returns:
        the enabled - Flag to indicate if this promotion is enabled.

      • getEndDate

        @Accessor(qualifier="endDate",
          type=GETTER)
public java.util.Date getEndDate()
        Generated method - Getter of the AbstractPromotion.endDate attribute defined at extension promotions.
        Returns:
        the endDate - Date on which this promotion stops being available, if not set the promotion will not be available.

      • getImmutableKey

        @Accessor(qualifier="immutableKey",
          type=GETTER)
public java.lang.String getImmutableKey()
        Generated method - Getter of the AbstractPromotion.immutableKey attribute defined at extension promotions.
        Returns:
        the immutableKey - The full immutable identifier for this promotion

      • getImmutableKeyHash

        @Accessor(qualifier="immutableKeyHash",
          type=GETTER)
public java.lang.String getImmutableKeyHash()
        Generated method - Getter of the AbstractPromotion.immutableKeyHash attribute defined at extension promotions.
        Returns:
        the immutableKeyHash - The HASH of the immutableKey

      • getName

        @Accessor(qualifier="name",
          type=GETTER)
public java.lang.String getName()
        Generated method - Getter of the AbstractPromotion.name attribute defined at extension acceleratorservices.
        Returns:
        the name - Displayable name for this promotion

      • getName

        @Accessor(qualifier="name",
          type=GETTER)
public java.lang.String getName​(java.util.Locale loc)
        Generated method - Getter of the AbstractPromotion.name attribute defined at extension acceleratorservices.
        Parameters:
        loc - the value localization key
        Returns:
        the name - Displayable name for this promotion
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • getPriority

        @Accessor(qualifier="priority",
          type=GETTER)
public java.lang.Integer getPriority()
        Generated method - Getter of the AbstractPromotion.priority attribute defined at extension promotions.
        Returns:
        the priority - Value to indicate relative priority of promotions. The higher the value the higher the priority.

      • getPromotionGroup

        @Accessor(qualifier="PromotionGroup",
          type=GETTER)
public PromotionGroupModel getPromotionGroup()
        Generated method - Getter of the AbstractPromotion.PromotionGroup attribute defined at extension promotions.
        Returns:
        the PromotionGroup

      • getPromotionType

        @Accessor(qualifier="promotionType",
          type=GETTER)
public java.lang.String getPromotionType()
        Generated method - Getter of the AbstractPromotion.promotionType attribute defined at extension promotions.
        Returns:
        the promotionType - The type of this promotion.

      • getPromotionType

        @Accessor(qualifier="promotionType",
          type=GETTER)
public java.lang.String getPromotionType​(java.util.Locale loc)
        Generated method - Getter of the AbstractPromotion.promotionType attribute defined at extension promotions.
        Parameters:
        loc - the value localization key
        Returns:
        the promotionType - The type of this promotion.
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • getRestrictions

        @Accessor(qualifier="restrictions",
          type=GETTER)
public java.util.Collection<AbstractPromotionRestrictionModel> getRestrictions()
        Generated method - Getter of the AbstractPromotion.restrictions attribute defined at extension promotions. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the restrictions - Collection of restrictions that are applied to this promotion

      • getStartDate

        @Accessor(qualifier="startDate",
          type=GETTER)
public java.util.Date getStartDate()
        Generated method - Getter of the AbstractPromotion.startDate attribute defined at extension promotions.
        Returns:
        the startDate - Date on which this promotion becomes available, if not set the promotion will not be available.

      • getTitle

        @Accessor(qualifier="title",
          type=GETTER)
public java.lang.String getTitle()
        Generated method - Getter of the AbstractPromotion.title attribute defined at extension promotions.
        Returns:
        the title - Title for this promotion

      • setCode

        @Accessor(qualifier="code",
          type=SETTER)
public void setCode​(java.lang.String value)
        Generated method - Setter of AbstractPromotion.code attribute defined at extension promotions.
        Parameters:
        value - the code - Identifier for this promotion

      • setDescription

        @Accessor(qualifier="description",
          type=SETTER)
public void setDescription​(java.lang.String value)
        Generated method - Setter of AbstractPromotion.description attribute defined at extension promotions.
        Parameters:
        value - the description - Description of this promotion

      • setDetailsURL

        @Accessor(qualifier="detailsURL",
          type=SETTER)
public void setDetailsURL​(java.lang.String value)
        Generated method - Setter of AbstractPromotion.detailsURL attribute defined at extension promotions.
        Parameters:
        value - the detailsURL - URL to a content page with further details of this promotion

      • setEnabled

        @Accessor(qualifier="enabled",
          type=SETTER)
public void setEnabled​(java.lang.Boolean value)
        Generated method - Setter of AbstractPromotion.enabled attribute defined at extension promotions.
        Parameters:
        value - the enabled - Flag to indicate if this promotion is enabled.

      • setEndDate

        @Accessor(qualifier="endDate",
          type=SETTER)
public void setEndDate​(java.util.Date value)
        Generated method - Setter of AbstractPromotion.endDate attribute defined at extension promotions.
        Parameters:
        value - the endDate - Date on which this promotion stops being available, if not set the promotion will not be available.

      • setImmutableKey

        @Accessor(qualifier="immutableKey",
          type=SETTER)
public void setImmutableKey​(java.lang.String value)
        Generated method - Setter of AbstractPromotion.immutableKey attribute defined at extension promotions.
        Parameters:
        value - the immutableKey - The full immutable identifier for this promotion

      • setImmutableKeyHash

        @Accessor(qualifier="immutableKeyHash",
          type=SETTER)
public void setImmutableKeyHash​(java.lang.String value)
        Generated method - Setter of AbstractPromotion.immutableKeyHash attribute defined at extension promotions.
        Parameters:
        value - the immutableKeyHash - The HASH of the immutableKey

      • setName

        @Accessor(qualifier="name",
          type=SETTER)
public void setName​(java.lang.String value)
        Generated method - Setter of AbstractPromotion.name attribute defined at extension acceleratorservices.
        Parameters:
        value - the name - Displayable name for this promotion

      • setName

        @Accessor(qualifier="name",
          type=SETTER)
public void setName​(java.lang.String value,
                    java.util.Locale loc)
        Generated method - Setter of AbstractPromotion.name attribute defined at extension acceleratorservices.
        Parameters:
        value - the name - Displayable name for this promotion
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • setPriority

        @Accessor(qualifier="priority",
          type=SETTER)
public void setPriority​(java.lang.Integer value)
        Generated method - Setter of AbstractPromotion.priority attribute defined at extension promotions.
        Parameters:
        value - the priority - Value to indicate relative priority of promotions. The higher the value the higher the priority.

      • setPromotionGroup

        @Accessor(qualifier="PromotionGroup",
          type=SETTER)
public void setPromotionGroup​(PromotionGroupModel value)
        Generated method - Setter of AbstractPromotion.PromotionGroup attribute defined at extension promotions.
        Parameters:
        value - the PromotionGroup

      • setRestrictions

        @Accessor(qualifier="restrictions",
          type=SETTER)
public void setRestrictions​(java.util.Collection<AbstractPromotionRestrictionModel> value)
        Generated method - Setter of AbstractPromotion.restrictions attribute defined at extension promotions.
        Parameters:
        value - the restrictions - Collection of restrictions that are applied to this promotion

      • setStartDate

        @Accessor(qualifier="startDate",
          type=SETTER)
public void setStartDate​(java.util.Date value)
        Generated method - Setter of AbstractPromotion.startDate attribute defined at extension promotions.
        Parameters:
        value - the startDate - Date on which this promotion becomes available, if not set the promotion will not be available.

      • setTitle

        @Accessor(qualifier="title",
          type=SETTER)
public void setTitle​(java.lang.String value)
        Generated method - Setter of AbstractPromotion.title attribute defined at extension promotions.
        Parameters:
        value - the title - Title for this promotion