Package de.hybris.platform.entitlementservices.model

Class ProductEntitlementModel

  • All Implemented Interfaces:
    java.io.Serializable
    public class ProductEntitlementModel
extends ItemModel
    Generated model class for type ProductEntitlement first defined at extension entitlementservices.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _PRODUCT2PRODUCTENTITLEMENTSRELATION
      Generated relation code constant for relation Product2ProductEntitlementsRelation defining source attribute subscriptionProduct in extension entitlementservices.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String CATALOGVERSION
      Generated constant - Attribute key of ProductEntitlement.catalogVersion attribute defined at extension entitlementservices.
      static java.lang.String CONDITIONGEO
      Generated constant - Attribute key of ProductEntitlement.conditionGeo attribute defined at extension entitlementservices.
      static java.lang.String CONDITIONPATH
      Generated constant - Attribute key of ProductEntitlement.conditionPath attribute defined at extension entitlementservices.
      static java.lang.String CONDITIONSTRING
      Generated constant - Attribute key of ProductEntitlement.conditionString attribute defined at extension entitlementservices.
      static java.lang.String DESCRIPTION
      Generated constant - Attribute key of ProductEntitlement.description attribute defined at extension entitlementservices.
      static java.lang.String ENTITLEMENT
      Generated constant - Attribute key of ProductEntitlement.entitlement attribute defined at extension entitlementservices.
      static java.lang.String ID
      Generated constant - Attribute key of ProductEntitlement.id attribute defined at extension entitlementservices.
      static java.lang.String QUANTITY
      Generated constant - Attribute key of ProductEntitlement.quantity attribute defined at extension entitlementservices.
      static java.lang.String SUBSCRIPTIONPRODUCT
      Generated constant - Attribute key of ProductEntitlement.subscriptionProduct attribute defined at extension entitlementservices.
      static java.lang.String TIMEUNIT
      Generated constant - Attribute key of ProductEntitlement.timeUnit attribute defined at extension entitlementservices.
      static java.lang.String TIMEUNITDURATION
      Generated constant - Attribute key of ProductEntitlement.timeUnitDuration attribute defined at extension entitlementservices.
      static java.lang.String TIMEUNITSTART
      Generated constant - Attribute key of ProductEntitlement.timeUnitStart attribute defined at extension entitlementservices.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      CatalogVersionModel getCatalogVersion()
      Generated method - Getter of the ProductEntitlement.catalogVersion attribute defined at extension entitlementservices.
      java.util.Collection<java.lang.String> getConditionGeo()
      Generated method - Getter of the ProductEntitlement.conditionGeo attribute defined at extension entitlementservices.
      java.lang.String getConditionPath()
      Generated method - Getter of the ProductEntitlement.conditionPath attribute defined at extension entitlementservices.
      java.lang.String getConditionString()
      Generated method - Getter of the ProductEntitlement.conditionString attribute defined at extension entitlementservices.
      java.lang.String getDescription()
      Generated method - Getter of the ProductEntitlement.description attribute defined at extension entitlementservices.
      java.lang.String getDescription​(java.util.Locale loc)
      Generated method - Getter of the ProductEntitlement.description attribute defined at extension entitlementservices.
      EntitlementModel getEntitlement()
      Generated method - Getter of the ProductEntitlement.entitlement attribute defined at extension entitlementservices.
      java.lang.String getId()
      Generated method - Getter of the ProductEntitlement.id attribute defined at extension entitlementservices.
      java.lang.Integer getQuantity()
      Generated method - Getter of the ProductEntitlement.quantity attribute defined at extension entitlementservices.
      ProductModel getSubscriptionProduct()
      Generated method - Getter of the ProductEntitlement.subscriptionProduct attribute defined at extension entitlementservices.
      EntitlementTimeUnit getTimeUnit()
      Generated method - Getter of the ProductEntitlement.timeUnit attribute defined at extension entitlementservices.
      java.lang.Integer getTimeUnitDuration()
      Generated method - Getter of the ProductEntitlement.timeUnitDuration attribute defined at extension entitlementservices.
      java.lang.Integer getTimeUnitStart()
      Generated method - Getter of the ProductEntitlement.timeUnitStart attribute defined at extension entitlementservices.
      void setCatalogVersion​(CatalogVersionModel value)
      Generated method - Initial setter of ProductEntitlement.catalogVersion attribute defined at extension entitlementservices.
      void setConditionGeo​(java.util.Collection<java.lang.String> value)
      Generated method - Setter of ProductEntitlement.conditionGeo attribute defined at extension entitlementservices.
      void setConditionPath​(java.lang.String value)
      Generated method - Setter of ProductEntitlement.conditionPath attribute defined at extension entitlementservices.
      void setConditionString​(java.lang.String value)
      Generated method - Setter of ProductEntitlement.conditionString attribute defined at extension entitlementservices.
      void setDescription​(java.lang.String value)
      Generated method - Setter of ProductEntitlement.description attribute defined at extension entitlementservices.
      void setDescription​(java.lang.String value, java.util.Locale loc)
      Generated method - Setter of ProductEntitlement.description attribute defined at extension entitlementservices.
      void setEntitlement​(EntitlementModel value)
      Generated method - Setter of ProductEntitlement.entitlement attribute defined at extension entitlementservices.
      void setId​(java.lang.String value)
      Generated method - Initial setter of ProductEntitlement.id attribute defined at extension entitlementservices.
      void setQuantity​(java.lang.Integer value)
      Generated method - Setter of ProductEntitlement.quantity attribute defined at extension entitlementservices.
      void setSubscriptionProduct​(ProductModel value)
      Generated method - Setter of ProductEntitlement.subscriptionProduct attribute defined at extension entitlementservices.
      void setTimeUnit​(EntitlementTimeUnit value)
      Generated method - Setter of ProductEntitlement.timeUnit attribute defined at extension entitlementservices.
      void setTimeUnitDuration​(java.lang.Integer value)
      Generated method - Setter of ProductEntitlement.timeUnitDuration attribute defined at extension entitlementservices.
      void setTimeUnitStart​(java.lang.Integer value)
      Generated method - Setter of ProductEntitlement.timeUnitStart attribute defined at extension entitlementservices.

      • 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

      • _PRODUCT2PRODUCTENTITLEMENTSRELATION

        public static final java.lang.String _PRODUCT2PRODUCTENTITLEMENTSRELATION
        Generated relation code constant for relation Product2ProductEntitlementsRelation defining source attribute subscriptionProduct in extension entitlementservices.
        See Also:
        Constant Field Values

      • ID

        public static final java.lang.String ID
        Generated constant - Attribute key of ProductEntitlement.id attribute defined at extension entitlementservices.
        See Also:
        Constant Field Values

      • DESCRIPTION

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

      • CATALOGVERSION

        public static final java.lang.String CATALOGVERSION
        Generated constant - Attribute key of ProductEntitlement.catalogVersion attribute defined at extension entitlementservices.
        See Also:
        Constant Field Values

      • TIMEUNIT

        public static final java.lang.String TIMEUNIT
        Generated constant - Attribute key of ProductEntitlement.timeUnit attribute defined at extension entitlementservices.
        See Also:
        Constant Field Values

      • TIMEUNITSTART

        public static final java.lang.String TIMEUNITSTART
        Generated constant - Attribute key of ProductEntitlement.timeUnitStart attribute defined at extension entitlementservices.
        See Also:
        Constant Field Values

      • TIMEUNITDURATION

        public static final java.lang.String TIMEUNITDURATION
        Generated constant - Attribute key of ProductEntitlement.timeUnitDuration attribute defined at extension entitlementservices.
        See Also:
        Constant Field Values

      • CONDITIONSTRING

        public static final java.lang.String CONDITIONSTRING
        Generated constant - Attribute key of ProductEntitlement.conditionString attribute defined at extension entitlementservices.
        See Also:
        Constant Field Values

      • CONDITIONPATH

        public static final java.lang.String CONDITIONPATH
        Generated constant - Attribute key of ProductEntitlement.conditionPath attribute defined at extension entitlementservices.
        See Also:
        Constant Field Values

      • CONDITIONGEO

        public static final java.lang.String CONDITIONGEO
        Generated constant - Attribute key of ProductEntitlement.conditionGeo attribute defined at extension entitlementservices.
        See Also:
        Constant Field Values

      • QUANTITY

        public static final java.lang.String QUANTITY
        Generated constant - Attribute key of ProductEntitlement.quantity attribute defined at extension entitlementservices.
        See Also:
        Constant Field Values

      • SUBSCRIPTIONPRODUCT

        public static final java.lang.String SUBSCRIPTIONPRODUCT
        Generated constant - Attribute key of ProductEntitlement.subscriptionProduct attribute defined at extension entitlementservices.
        See Also:
        Constant Field Values

      • ENTITLEMENT

        public static final java.lang.String ENTITLEMENT
        Generated constant - Attribute key of ProductEntitlement.entitlement attribute defined at extension entitlementservices.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ProductEntitlementModel

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

      • ProductEntitlementModel

        public ProductEntitlementModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null

      • ProductEntitlementModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public ProductEntitlementModel​(EntitlementModel _entitlement,
                               ProductModel _subscriptionProduct)
        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:
        _entitlement - initial attribute declared by type ProductEntitlement at extension entitlementservices
        _subscriptionProduct - initial attribute declared by type ProductEntitlement at extension entitlementservices

      • ProductEntitlementModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public ProductEntitlementModel​(CatalogVersionModel _catalogVersion,
                               EntitlementModel _entitlement,
                               java.lang.String _id,
                               ItemModel _owner,
                               ProductModel _subscriptionProduct)
        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:
        _catalogVersion - initial attribute declared by type ProductEntitlement at extension entitlementservices
        _entitlement - initial attribute declared by type ProductEntitlement at extension entitlementservices
        _id - initial attribute declared by type ProductEntitlement at extension entitlementservices
        _owner - initial attribute declared by type Item at extension core
        _subscriptionProduct - initial attribute declared by type ProductEntitlement at extension entitlementservices

    • Method Detail

      • getCatalogVersion

        @Accessor(qualifier="catalogVersion",
          type=GETTER)
public CatalogVersionModel getCatalogVersion()
        Generated method - Getter of the ProductEntitlement.catalogVersion attribute defined at extension entitlementservices.
        Returns:
        the catalogVersion - Catalog Version

      • getConditionGeo

        @Accessor(qualifier="conditionGeo",
          type=GETTER)
public java.util.Collection<java.lang.String> getConditionGeo()
        Generated method - Getter of the ProductEntitlement.conditionGeo attribute defined at extension entitlementservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the conditionGeo - Geo Condition

      • getConditionPath

        @Accessor(qualifier="conditionPath",
          type=GETTER)
public java.lang.String getConditionPath()
        Generated method - Getter of the ProductEntitlement.conditionPath attribute defined at extension entitlementservices.
        Returns:
        the conditionPath - Path Condition

      • getConditionString

        @Accessor(qualifier="conditionString",
          type=GETTER)
public java.lang.String getConditionString()
        Generated method - Getter of the ProductEntitlement.conditionString attribute defined at extension entitlementservices.
        Returns:
        the conditionString - String Condition

      • getDescription

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

      • getDescription

        @Accessor(qualifier="description",
          type=GETTER)
public java.lang.String getDescription​(java.util.Locale loc)
        Generated method - Getter of the ProductEntitlement.description attribute defined at extension entitlementservices.
        Parameters:
        loc - the value localization key
        Returns:
        the description - Description
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • getEntitlement

        @Accessor(qualifier="entitlement",
          type=GETTER)
public EntitlementModel getEntitlement()
        Generated method - Getter of the ProductEntitlement.entitlement attribute defined at extension entitlementservices.
        Returns:
        the entitlement

      • getId

        @Accessor(qualifier="id",
          type=GETTER)
public java.lang.String getId()
        Generated method - Getter of the ProductEntitlement.id attribute defined at extension entitlementservices.
        Returns:
        the id - Identifier

      • getQuantity

        @Accessor(qualifier="quantity",
          type=GETTER)
public java.lang.Integer getQuantity()
        Generated method - Getter of the ProductEntitlement.quantity attribute defined at extension entitlementservices.
        Returns:
        the quantity - Quantity

      • getSubscriptionProduct

        @Accessor(qualifier="subscriptionProduct",
          type=GETTER)
public ProductModel getSubscriptionProduct()
        Generated method - Getter of the ProductEntitlement.subscriptionProduct attribute defined at extension entitlementservices.
        Returns:
        the subscriptionProduct

      • getTimeUnit

        @Accessor(qualifier="timeUnit",
          type=GETTER)
public EntitlementTimeUnit getTimeUnit()
        Generated method - Getter of the ProductEntitlement.timeUnit attribute defined at extension entitlementservices.
        Returns:
        the timeUnit - Time Unit

      • getTimeUnitDuration

        @Accessor(qualifier="timeUnitDuration",
          type=GETTER)
public java.lang.Integer getTimeUnitDuration()
        Generated method - Getter of the ProductEntitlement.timeUnitDuration attribute defined at extension entitlementservices.
        Returns:
        the timeUnitDuration - Duration

      • getTimeUnitStart

        @Accessor(qualifier="timeUnitStart",
          type=GETTER)
public java.lang.Integer getTimeUnitStart()
        Generated method - Getter of the ProductEntitlement.timeUnitStart attribute defined at extension entitlementservices.
        Returns:
        the timeUnitStart - Start

      • setCatalogVersion

        @Accessor(qualifier="catalogVersion",
          type=SETTER)
public void setCatalogVersion​(CatalogVersionModel value)
        Generated method - Initial setter of ProductEntitlement.catalogVersion attribute defined at extension entitlementservices. Can only be used at creation of model - before first save.
        Parameters:
        value - the catalogVersion - Catalog Version

      • setConditionGeo

        @Accessor(qualifier="conditionGeo",
          type=SETTER)
public void setConditionGeo​(java.util.Collection<java.lang.String> value)
        Generated method - Setter of ProductEntitlement.conditionGeo attribute defined at extension entitlementservices.
        Parameters:
        value - the conditionGeo - Geo Condition

      • setConditionPath

        @Accessor(qualifier="conditionPath",
          type=SETTER)
public void setConditionPath​(java.lang.String value)
        Generated method - Setter of ProductEntitlement.conditionPath attribute defined at extension entitlementservices.
        Parameters:
        value - the conditionPath - Path Condition

      • setConditionString

        @Accessor(qualifier="conditionString",
          type=SETTER)
public void setConditionString​(java.lang.String value)
        Generated method - Setter of ProductEntitlement.conditionString attribute defined at extension entitlementservices.
        Parameters:
        value - the conditionString - String Condition

      • setDescription

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

      • setDescription

        @Accessor(qualifier="description",
          type=SETTER)
public void setDescription​(java.lang.String value,
                           java.util.Locale loc)
        Generated method - Setter of ProductEntitlement.description attribute defined at extension entitlementservices.
        Parameters:
        value - the description - Description
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • setEntitlement

        @Accessor(qualifier="entitlement",
          type=SETTER)
public void setEntitlement​(EntitlementModel value)
        Generated method - Setter of ProductEntitlement.entitlement attribute defined at extension entitlementservices.
        Parameters:
        value - the entitlement

      • setId

        @Accessor(qualifier="id",
          type=SETTER)
public void setId​(java.lang.String value)
        Generated method - Initial setter of ProductEntitlement.id attribute defined at extension entitlementservices. Can only be used at creation of model - before first save.
        Parameters:
        value - the id - Identifier

      • setQuantity

        @Accessor(qualifier="quantity",
          type=SETTER)
public void setQuantity​(java.lang.Integer value)
        Generated method - Setter of ProductEntitlement.quantity attribute defined at extension entitlementservices.
        Parameters:
        value - the quantity - Quantity

      • setSubscriptionProduct

        @Accessor(qualifier="subscriptionProduct",
          type=SETTER)
public void setSubscriptionProduct​(ProductModel value)
        Generated method - Setter of ProductEntitlement.subscriptionProduct attribute defined at extension entitlementservices.
        Parameters:
        value - the subscriptionProduct

      • setTimeUnit

        @Accessor(qualifier="timeUnit",
          type=SETTER)
public void setTimeUnit​(EntitlementTimeUnit value)
        Generated method - Setter of ProductEntitlement.timeUnit attribute defined at extension entitlementservices.
        Parameters:
        value - the timeUnit - Time Unit

      • setTimeUnitDuration

        @Accessor(qualifier="timeUnitDuration",
          type=SETTER)
public void setTimeUnitDuration​(java.lang.Integer value)
        Generated method - Setter of ProductEntitlement.timeUnitDuration attribute defined at extension entitlementservices.
        Parameters:
        value - the timeUnitDuration - Duration

      • setTimeUnitStart

        @Accessor(qualifier="timeUnitStart",
          type=SETTER)
public void setTimeUnitStart​(java.lang.Integer value)
        Generated method - Setter of ProductEntitlement.timeUnitStart attribute defined at extension entitlementservices.
        Parameters:
        value - the timeUnitStart - Start