Package de.hybris.platform.campaigns.model

Class CampaignModel

  • All Implemented Interfaces:
    java.io.Serializable
    public class CampaignModel
extends ItemModel
    Generated model class for type Campaign first defined at extension basecommerce.

    Campaign information.

    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 _CAMPAIGNSFORRESTRICTION
      Generated relation code constant for relation CampaignsForRestriction defining source attribute restrictions in extension cms2.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String CODE
      Generated constant - Attribute key of Campaign.code attribute defined at extension basecommerce.
      static java.lang.String DESCRIPTION
      Generated constant - Attribute key of Campaign.description attribute defined at extension basecommerce.
      static java.lang.String ENABLED
      Generated constant - Attribute key of Campaign.enabled attribute defined at extension basecommerce.
      static java.lang.String ENDDATE
      Generated constant - Attribute key of Campaign.endDate attribute defined at extension basecommerce.
      static java.lang.String NAME
      Generated constant - Attribute key of Campaign.name attribute defined at extension basecommerce.
      static java.lang.String RESTRICTIONS
      Generated constant - Attribute key of Campaign.restrictions attribute defined at extension cms2.
      static java.lang.String SOURCERULES
      Generated constant - Attribute key of Campaign.sourceRules attribute defined at extension ruleengineservices.
      static java.lang.String STARTDATE
      Generated constant - Attribute key of Campaign.startDate attribute defined at extension basecommerce.

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

        LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

    • Constructor Summary

      Constructors 
      Constructor Description
      CampaignModel()
      Generated constructor - Default constructor for generic creation.
      CampaignModel​(de.hybris.platform.servicelayer.model.ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      CampaignModel​(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
      CampaignModel​(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 Campaign.code attribute defined at extension basecommerce.
      java.lang.String getDescription()
      Generated method - Getter of the Campaign.description attribute defined at extension basecommerce.
      java.lang.String getDescription​(java.util.Locale loc)
      Generated method - Getter of the Campaign.description attribute defined at extension basecommerce.
      java.lang.Boolean getEnabled()
      Generated method - Getter of the Campaign.enabled attribute defined at extension basecommerce.
      java.util.Date getEndDate()
      Generated method - Getter of the Campaign.endDate attribute defined at extension basecommerce.
      java.lang.String getName()
      Generated method - Getter of the Campaign.name attribute defined at extension basecommerce.
      java.lang.String getName​(java.util.Locale loc)
      Generated method - Getter of the Campaign.name attribute defined at extension basecommerce.
      java.util.Collection<CMSCampaignRestrictionModel> getRestrictions()
      Generated method - Getter of the Campaign.restrictions attribute defined at extension cms2.
      java.util.Set<SourceRuleModel> getSourceRules()
      Generated method - Getter of the Campaign.sourceRules attribute defined at extension ruleengineservices.
      java.util.Date getStartDate()
      Generated method - Getter of the Campaign.startDate attribute defined at extension basecommerce.
      void setCode​(java.lang.String value)
      Generated method - Setter of Campaign.code attribute defined at extension basecommerce.
      void setDescription​(java.lang.String value)
      Generated method - Setter of Campaign.description attribute defined at extension basecommerce.
      void setDescription​(java.lang.String value, java.util.Locale loc)
      Generated method - Setter of Campaign.description attribute defined at extension basecommerce.
      void setEnabled​(java.lang.Boolean value)
      Generated method - Setter of Campaign.enabled attribute defined at extension basecommerce.
      void setEndDate​(java.util.Date value)
      Generated method - Setter of Campaign.endDate attribute defined at extension basecommerce.
      void setName​(java.lang.String value)
      Generated method - Setter of Campaign.name attribute defined at extension basecommerce.
      void setName​(java.lang.String value, java.util.Locale loc)
      Generated method - Setter of Campaign.name attribute defined at extension basecommerce.
      void setRestrictions​(java.util.Collection<CMSCampaignRestrictionModel> value)
      Generated method - Setter of Campaign.restrictions attribute defined at extension cms2.
      void setSourceRules​(java.util.Set<SourceRuleModel> value)
      Generated method - Setter of Campaign.sourceRules attribute defined at extension ruleengineservices.
      void setStartDate​(java.util.Date value)
      Generated method - Setter of Campaign.startDate attribute defined at extension basecommerce.

      • 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

      • _CAMPAIGNSFORRESTRICTION

        public static final java.lang.String _CAMPAIGNSFORRESTRICTION
        Generated relation code constant for relation CampaignsForRestriction defining source attribute restrictions in extension cms2.
        See Also:
        Constant Field Values

      • CODE

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

      • NAME

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

      • DESCRIPTION

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

      • STARTDATE

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

      • ENDDATE

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

      • ENABLED

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

      • RESTRICTIONS

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

      • SOURCERULES

        public static final java.lang.String SOURCERULES
        Generated constant - Attribute key of Campaign.sourceRules attribute defined at extension ruleengineservices.
        See Also:
        Constant Field Values

    • Constructor Detail

      • CampaignModel

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

      • CampaignModel

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

      • CampaignModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public CampaignModel​(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 Campaign at extension basecommerce

      • CampaignModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public CampaignModel​(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 Campaign at extension basecommerce
        _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 Campaign.code attribute defined at extension basecommerce.
        Returns:
        the code

      • getDescription

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

      • getDescription

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

      • getEnabled

        @Accessor(qualifier="enabled",
          type=GETTER)
public java.lang.Boolean getEnabled()
        Generated method - Getter of the Campaign.enabled attribute defined at extension basecommerce.
        Returns:
        the enabled

      • getEndDate

        @Accessor(qualifier="endDate",
          type=GETTER)
public java.util.Date getEndDate()
        Generated method - Getter of the Campaign.endDate attribute defined at extension basecommerce.
        Returns:
        the endDate

      • getName

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

      • getName

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

      • getRestrictions

        @Accessor(qualifier="restrictions",
          type=GETTER)
public java.util.Collection<CMSCampaignRestrictionModel> getRestrictions()
        Generated method - Getter of the Campaign.restrictions attribute defined at extension cms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the restrictions

      • getSourceRules

        @Accessor(qualifier="sourceRules",
          type=GETTER)
public java.util.Set<SourceRuleModel> getSourceRules()
        Generated method - Getter of the Campaign.sourceRules attribute defined at extension ruleengineservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the sourceRules

      • getStartDate

        @Accessor(qualifier="startDate",
          type=GETTER)
public java.util.Date getStartDate()
        Generated method - Getter of the Campaign.startDate attribute defined at extension basecommerce.
        Returns:
        the startDate

      • setCode

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

      • setDescription

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

      • setDescription

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

      • setEnabled

        @Accessor(qualifier="enabled",
          type=SETTER)
public void setEnabled​(java.lang.Boolean value)
        Generated method - Setter of Campaign.enabled attribute defined at extension basecommerce.
        Parameters:
        value - the enabled

      • setEndDate

        @Accessor(qualifier="endDate",
          type=SETTER)
public void setEndDate​(java.util.Date value)
        Generated method - Setter of Campaign.endDate attribute defined at extension basecommerce.
        Parameters:
        value - the endDate

      • setName

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

      • setName

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

      • setRestrictions

        @Accessor(qualifier="restrictions",
          type=SETTER)
public void setRestrictions​(java.util.Collection<CMSCampaignRestrictionModel> value)
        Generated method - Setter of Campaign.restrictions attribute defined at extension cms2.
        Parameters:
        value - the restrictions

      • setSourceRules

        @Accessor(qualifier="sourceRules",
          type=SETTER)
public void setSourceRules​(java.util.Set<SourceRuleModel> value)
        Generated method - Setter of Campaign.sourceRules attribute defined at extension ruleengineservices.
        Parameters:
        value - the sourceRules

      • setStartDate

        @Accessor(qualifier="startDate",
          type=SETTER)
public void setStartDate​(java.util.Date value)
        Generated method - Setter of Campaign.startDate attribute defined at extension basecommerce.
        Parameters:
        value - the startDate