Package de.hybris.platform.commerceservices.model.consent

Class ConsentTemplateModel

  • All Implemented Interfaces:
    java.io.Serializable
    public class ConsentTemplateModel
extends ItemModel
    Generated model class for type ConsentTemplate first defined at extension commerceservices.

    A type of consent associated with a particular store.

    See Also:
    Serialized Form

    • 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 _TYPECODE
      Generated model type code constant.
      static java.lang.String BASESITE
      Generated constant - Attribute key of ConsentTemplate.baseSite attribute defined at extension commerceservices.
      static java.lang.String DESCRIPTION
      Generated constant - Attribute key of ConsentTemplate.description attribute defined at extension commerceservices.
      static java.lang.String EXPOSED
      Generated constant - Attribute key of ConsentTemplate.exposed attribute defined at extension commerceservices.
      static java.lang.String ID
      Generated constant - Attribute key of ConsentTemplate.id attribute defined at extension commerceservices.
      static java.lang.String NAME
      Generated constant - Attribute key of ConsentTemplate.name attribute defined at extension commerceservices.
      static java.lang.String VERSION
      Generated constant - Attribute key of ConsentTemplate.version attribute defined at extension commerceservices.

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

        LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

    • Constructor Summary

      Constructors 
      Constructor Description
      ConsentTemplateModel()
      Generated constructor - Default constructor for generic creation.
      ConsentTemplateModel​(BaseSiteModel _baseSite, java.lang.String _id, ItemModel _owner, java.lang.Integer _version)
      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
      ConsentTemplateModel​(BaseSiteModel _baseSite, java.lang.String _id, java.lang.Integer _version)
      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
      ConsentTemplateModel​(de.hybris.platform.servicelayer.model.ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      BaseSiteModel getBaseSite()
      Generated method - Getter of the ConsentTemplate.baseSite attribute defined at extension commerceservices.
      java.lang.String getDescription()
      Generated method - Getter of the ConsentTemplate.description attribute defined at extension commerceservices.
      java.lang.String getDescription​(java.util.Locale loc)
      Generated method - Getter of the ConsentTemplate.description attribute defined at extension commerceservices.
      java.lang.String getId()
      Generated method - Getter of the ConsentTemplate.id attribute defined at extension commerceservices.
      java.lang.String getName()
      Generated method - Getter of the ConsentTemplate.name attribute defined at extension commerceservices.
      java.lang.String getName​(java.util.Locale loc)
      Generated method - Getter of the ConsentTemplate.name attribute defined at extension commerceservices.
      java.lang.Integer getVersion()
      Generated method - Getter of the ConsentTemplate.version attribute defined at extension commerceservices.
      boolean isExposed()
      Generated method - Getter of the ConsentTemplate.exposed attribute defined at extension commerceservices.
      void setBaseSite​(BaseSiteModel value)
      Generated method - Setter of ConsentTemplate.baseSite attribute defined at extension commerceservices.
      void setDescription​(java.lang.String value)
      Generated method - Setter of ConsentTemplate.description attribute defined at extension commerceservices.
      void setDescription​(java.lang.String value, java.util.Locale loc)
      Generated method - Setter of ConsentTemplate.description attribute defined at extension commerceservices.
      void setExposed​(boolean value)
      Generated method - Setter of ConsentTemplate.exposed attribute defined at extension commerceservices.
      void setId​(java.lang.String value)
      Generated method - Setter of ConsentTemplate.id attribute defined at extension commerceservices.
      void setName​(java.lang.String value)
      Generated method - Setter of ConsentTemplate.name attribute defined at extension commerceservices.
      void setName​(java.lang.String value, java.util.Locale loc)
      Generated method - Setter of ConsentTemplate.name attribute defined at extension commerceservices.
      void setVersion​(java.lang.Integer value)
      Generated method - Setter of ConsentTemplate.version attribute defined at extension commerceservices.

      • 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

      • ID

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

      • VERSION

        public static final java.lang.String VERSION
        Generated constant - Attribute key of ConsentTemplate.version attribute defined at extension commerceservices.
        See Also:
        Constant Field Values

      • BASESITE

        public static final java.lang.String BASESITE
        Generated constant - Attribute key of ConsentTemplate.baseSite attribute defined at extension commerceservices.
        See Also:
        Constant Field Values

      • NAME

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

      • EXPOSED

        public static final java.lang.String EXPOSED
        Generated constant - Attribute key of ConsentTemplate.exposed attribute defined at extension commerceservices.
        See Also:
        Constant Field Values

      • DESCRIPTION

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

    • Constructor Detail

      • ConsentTemplateModel

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

      • ConsentTemplateModel

        public ConsentTemplateModel​(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

      • ConsentTemplateModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public ConsentTemplateModel​(BaseSiteModel _baseSite,
                            java.lang.String _id,
                            java.lang.Integer _version)
        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:
        _baseSite - initial attribute declared by type ConsentTemplate at extension commerceservices
        _id - initial attribute declared by type ConsentTemplate at extension commerceservices
        _version - initial attribute declared by type ConsentTemplate at extension commerceservices

      • ConsentTemplateModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public ConsentTemplateModel​(BaseSiteModel _baseSite,
                            java.lang.String _id,
                            ItemModel _owner,
                            java.lang.Integer _version)
        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:
        _baseSite - initial attribute declared by type ConsentTemplate at extension commerceservices
        _id - initial attribute declared by type ConsentTemplate at extension commerceservices
        _owner - initial attribute declared by type Item at extension core
        _version - initial attribute declared by type ConsentTemplate at extension commerceservices

    • Method Detail

      • getBaseSite

        @Accessor(qualifier="baseSite",
          type=GETTER)
public BaseSiteModel getBaseSite()
        Generated method - Getter of the ConsentTemplate.baseSite attribute defined at extension commerceservices.
        Returns:
        the baseSite - BaseSite that this consent template belongs to

      • getDescription

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

      • getDescription

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

      • getId

        @Accessor(qualifier="id",
          type=GETTER)
public java.lang.String getId()
        Generated method - Getter of the ConsentTemplate.id attribute defined at extension commerceservices.
        Returns:
        the id - Consent Template ID

      • getName

        @Accessor(qualifier="name",
          type=GETTER)
public java.lang.String getName()
        Generated method - Getter of the ConsentTemplate.name attribute defined at extension commerceservices.
        Returns:
        the name - Consent Template Name

      • getName

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

      • getVersion

        @Accessor(qualifier="version",
          type=GETTER)
public java.lang.Integer getVersion()
        Generated method - Getter of the ConsentTemplate.version attribute defined at extension commerceservices.
        Returns:
        the version - Consent Template Version

      • isExposed

        @Accessor(qualifier="exposed",
          type=GETTER)
public boolean isExposed()
        Generated method - Getter of the ConsentTemplate.exposed attribute defined at extension commerceservices.
        Returns:
        the exposed - Indicates whether the consent template should be exposed to integrators in a storefront implementation as part of cookie and session information

      • setBaseSite

        @Accessor(qualifier="baseSite",
          type=SETTER)
public void setBaseSite​(BaseSiteModel value)
        Generated method - Setter of ConsentTemplate.baseSite attribute defined at extension commerceservices.
        Parameters:
        value - the baseSite - BaseSite that this consent template belongs to

      • setDescription

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

      • setDescription

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

      • setExposed

        @Accessor(qualifier="exposed",
          type=SETTER)
public void setExposed​(boolean value)
        Generated method - Setter of ConsentTemplate.exposed attribute defined at extension commerceservices.
        Parameters:
        value - the exposed - Indicates whether the consent template should be exposed to integrators in a storefront implementation as part of cookie and session information

      • setId

        @Accessor(qualifier="id",
          type=SETTER)
public void setId​(java.lang.String value)
        Generated method - Setter of ConsentTemplate.id attribute defined at extension commerceservices.
        Parameters:
        value - the id - Consent Template ID

      • setName

        @Accessor(qualifier="name",
          type=SETTER)
public void setName​(java.lang.String value)
        Generated method - Setter of ConsentTemplate.name attribute defined at extension commerceservices.
        Parameters:
        value - the name - Consent Template Name

      • setName

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

      • setVersion

        @Accessor(qualifier="version",
          type=SETTER)
public void setVersion​(java.lang.Integer value)
        Generated method - Setter of ConsentTemplate.version attribute defined at extension commerceservices.
        Parameters:
        value - the version - Consent Template Version