Package de.hybris.platform.promotions.model

Class PromotionResultModel

java.lang.Object
de.hybris.platform.servicelayer.model.AbstractItemModel
de.hybris.platform.core.model.ItemModel
de.hybris.platform.promotions.model.PromotionResultModel
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
CachedPromotionResultModel
public class PromotionResultModel extends ItemModel
Generated model class for type PromotionResult first defined at extension promotions.
See Also:

  • 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 final String
    _ORDER2PROMOTIONRESULTSRELATION
    Generated relation code constant for relation Order2PromotionResultsRelation defining source attribute order in extension promotions.
    static final String
    _TYPECODE
    Generated model type code constant.
    static final String
    ACTIONS
    Generated constant - Attribute key of PromotionResult.actions attribute defined at extension promotions.
    static final String
    ALLPROMOTIONACTIONS
    Generated constant - Attribute key of PromotionResult.allPromotionActions attribute defined at extension promotions.
    static final String
    CERTAINTY
    Generated constant - Attribute key of PromotionResult.certainty attribute defined at extension promotions.
    static final String
    CONSUMEDENTRIES
    Generated constant - Attribute key of PromotionResult.consumedEntries attribute defined at extension promotions.
    static final String
    CUSTOM
    Generated constant - Attribute key of PromotionResult.custom attribute defined at extension promotions.
    static final String
    MESSAGEFIRED
    Generated constant - Attribute key of PromotionResult.messageFired attribute defined at extension promotionengineservices.
    static final String
    MODULEVERSION
    Generated constant - Attribute key of PromotionResult.moduleVersion attribute defined at extension promotionengineservices.
    static final String
    ORDER
    Generated constant - Attribute key of PromotionResult.order attribute defined at extension promotions.
    static final String
    ORDERCODE
    Generated constant - Attribute key of PromotionResult.orderCode attribute defined at extension promotionengineservices.
    static final String
    PROMOTION
    Generated constant - Attribute key of PromotionResult.promotion attribute defined at extension promotions.
    static final String
    RULESMODULENAME
    Generated constant - Attribute key of PromotionResult.rulesModuleName attribute defined at extension promotionengineservices.
    static final String
    RULEVERSION
    Generated constant - Attribute key of PromotionResult.ruleVersion attribute defined at extension promotionengineservices.

    Fields inherited from class de.hybris.platform.core.model.ItemModel

    _COMMENTITEMRELATION, COMMENTS, CREATIONTIME, ITEMTYPE, MODIFIEDTIME, OWNER, PK, SEALED

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

    LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

  • Constructor Summary

    Constructors
    Constructor
    Description
    PromotionResultModel()
    Generated constructor - Default constructor for generic creation.
    PromotionResultModel(AbstractOrderModel _order)
    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
    PromotionResultModel(AbstractOrderModel _order, 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
    PromotionResultModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx)
    Generated constructor - Default constructor for creation with existing context

  • Method Summary

    Modifier and Type
    Method
    Description
    Collection<AbstractPromotionActionModel>
    getActions()
    Generated method - Getter of the PromotionResult.actions attribute defined at extension promotions.
    Set<AbstractPromotionActionModel>
    getAllPromotionActions()
    Generated method - Getter of the PromotionResult.allPromotionActions attribute defined at extension promotions.
    Float
    getCertainty()
    Generated method - Getter of the PromotionResult.certainty attribute defined at extension promotions.
    Collection<PromotionOrderEntryConsumedModel>
    getConsumedEntries()
    Generated method - Getter of the PromotionResult.consumedEntries attribute defined at extension promotions.
    String
    getCustom()
    Generated method - Getter of the PromotionResult.custom attribute defined at extension promotions.
    String
    getMessageFired()
    Generated method - Getter of the PromotionResult.messageFired attribute defined at extension promotionengineservices.
    String
    getMessageFired(Locale loc)
    Generated method - Getter of the PromotionResult.messageFired attribute defined at extension promotionengineservices.
    Long
    getModuleVersion()
    Generated method - Getter of the PromotionResult.moduleVersion attribute defined at extension promotionengineservices.
    AbstractOrderModel
    getOrder()
    Generated method - Getter of the PromotionResult.order attribute defined at extension promotions.
    String
    getOrderCode()
    Generated method - Getter of the PromotionResult.orderCode attribute defined at extension promotionengineservices.
    AbstractPromotionModel
    getPromotion()
    Generated method - Getter of the PromotionResult.promotion attribute defined at extension promotions.
    String
    getRulesModuleName()
    Generated method - Getter of the PromotionResult.rulesModuleName attribute defined at extension promotionengineservices.
    Long
    getRuleVersion()
    Generated method - Getter of the PromotionResult.ruleVersion attribute defined at extension promotionengineservices.
    void
    setActions(Collection<AbstractPromotionActionModel> value)
    Generated method - Setter of PromotionResult.actions attribute defined at extension promotions.
    void
    setAllPromotionActions(Set<AbstractPromotionActionModel> value)
    Generated method - Setter of PromotionResult.allPromotionActions attribute defined at extension promotions.
    void
    setCertainty(Float value)
    Generated method - Setter of PromotionResult.certainty attribute defined at extension promotions.
    void
    setConsumedEntries(Collection<PromotionOrderEntryConsumedModel> value)
    Generated method - Setter of PromotionResult.consumedEntries attribute defined at extension promotions.
    void
    setCustom(String value)
    Generated method - Setter of PromotionResult.custom attribute defined at extension promotions.
    void
    setMessageFired(String value)
    Generated method - Setter of PromotionResult.messageFired attribute defined at extension promotionengineservices.
    void
    setMessageFired(String value, Locale loc)
    Generated method - Setter of PromotionResult.messageFired attribute defined at extension promotionengineservices.
    void
    setModuleVersion(Long value)
    Generated method - Setter of PromotionResult.moduleVersion attribute defined at extension promotionengineservices.
    void
    setOrder(AbstractOrderModel value)
    Generated method - Setter of PromotionResult.order attribute defined at extension promotions.
    void
    setOrderCode(String value)
    Generated method - Setter of PromotionResult.orderCode attribute defined at extension promotionengineservices.
    void
    setPromotion(AbstractPromotionModel value)
    Generated method - Setter of PromotionResult.promotion attribute defined at extension promotions.
    void
    setRulesModuleName(String value)
    Generated method - Setter of PromotionResult.rulesModuleName attribute defined at extension promotionengineservices.
    void
    setRuleVersion(Long value)
    Generated method - Setter of PromotionResult.ruleVersion attribute defined at extension promotionengineservices.

    Methods inherited from class de.hybris.platform.core.model.ItemModel

    getComments, getCreationtime, getModifiedtime, getOwner, isSealed, setComments, setCreationtime, setModifiedtime, setOwner

    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 Details

    • _TYPECODE

      public static final String _TYPECODE
      Generated model type code constant.
      See Also:

    • _ORDER2PROMOTIONRESULTSRELATION

      public static final String _ORDER2PROMOTIONRESULTSRELATION
      Generated relation code constant for relation Order2PromotionResultsRelation defining source attribute order in extension promotions.
      See Also:

    • ACTIONS

      public static final String ACTIONS
      Generated constant - Attribute key of PromotionResult.actions attribute defined at extension promotions.
      See Also:

    • CONSUMEDENTRIES

      public static final String CONSUMEDENTRIES
      Generated constant - Attribute key of PromotionResult.consumedEntries attribute defined at extension promotions.
      See Also:

    • PROMOTION

      public static final String PROMOTION
      Generated constant - Attribute key of PromotionResult.promotion attribute defined at extension promotions.
      See Also:

    • CERTAINTY

      public static final String CERTAINTY
      Generated constant - Attribute key of PromotionResult.certainty attribute defined at extension promotions.
      See Also:

    • CUSTOM

      public static final String CUSTOM
      Generated constant - Attribute key of PromotionResult.custom attribute defined at extension promotions.
      See Also:

    • ORDER

      public static final String ORDER
      Generated constant - Attribute key of PromotionResult.order attribute defined at extension promotions.
      See Also:

    • ALLPROMOTIONACTIONS

      public static final String ALLPROMOTIONACTIONS
      Generated constant - Attribute key of PromotionResult.allPromotionActions attribute defined at extension promotions.
      See Also:

    • RULESMODULENAME

      public static final String RULESMODULENAME
      Generated constant - Attribute key of PromotionResult.rulesModuleName attribute defined at extension promotionengineservices.
      See Also:

    • MODULEVERSION

      public static final String MODULEVERSION
      Generated constant - Attribute key of PromotionResult.moduleVersion attribute defined at extension promotionengineservices.
      See Also:

    • RULEVERSION

      public static final String RULEVERSION
      Generated constant - Attribute key of PromotionResult.ruleVersion attribute defined at extension promotionengineservices.
      See Also:

    • MESSAGEFIRED

      public static final String MESSAGEFIRED
      Generated constant - Attribute key of PromotionResult.messageFired attribute defined at extension promotionengineservices.
      See Also:

    • ORDERCODE

      public static final String ORDERCODE
      Generated constant - Attribute key of PromotionResult.orderCode attribute defined at extension promotionengineservices.
      See Also:

  • Constructor Details

    • PromotionResultModel

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

    • PromotionResultModel

      public PromotionResultModel(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

    • PromotionResultModel

      @Deprecated(since="4.1.1", forRemoval=true) public PromotionResultModel(AbstractOrderModel _order)
      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:
      _order - initial attribute declared by type PromotionResult at extension promotions

    • PromotionResultModel

      @Deprecated(since="4.1.1", forRemoval=true) public PromotionResultModel(AbstractOrderModel _order, 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:
      _order - initial attribute declared by type PromotionResult at extension promotions
      _owner - initial attribute declared by type Item at extension core

  • Method Details

    • getActions

      @Accessor(qualifier="actions", type=GETTER) public Collection<AbstractPromotionActionModel> getActions()
      Generated method - Getter of the PromotionResult.actions attribute defined at extension promotions. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the actions - List of actions

    • getAllPromotionActions

      @Accessor(qualifier="allPromotionActions", type=GETTER) public Set<AbstractPromotionActionModel> getAllPromotionActions()
      Generated method - Getter of the PromotionResult.allPromotionActions attribute defined at extension promotions. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the allPromotionActions

    • getCertainty

      @Accessor(qualifier="certainty", type=GETTER) public Float getCertainty()
      Generated method - Getter of the PromotionResult.certainty attribute defined at extension promotions.
      Returns:
      the certainty - Certainty

    • getConsumedEntries

      @Accessor(qualifier="consumedEntries", type=GETTER) public Collection<PromotionOrderEntryConsumedModel> getConsumedEntries()
      Generated method - Getter of the PromotionResult.consumedEntries attribute defined at extension promotions. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the consumedEntries - List of consumed entries

    • getCustom

      @Accessor(qualifier="custom", type=GETTER) public String getCustom()
      Generated method - Getter of the PromotionResult.custom attribute defined at extension promotions.
      Returns:
      the custom - Custom data stored on this promotion result by the promotion.

    • getMessageFired

      @Accessor(qualifier="messageFired", type=GETTER) public String getMessageFired()
      Generated method - Getter of the PromotionResult.messageFired attribute defined at extension promotionengineservices.
      Returns:
      the messageFired - fired promotion description message

    • getMessageFired

      @Accessor(qualifier="messageFired", type=GETTER) public String getMessageFired(Locale loc)
      Generated method - Getter of the PromotionResult.messageFired attribute defined at extension promotionengineservices.
      Parameters:
      loc - the value localization key
      Returns:
      the messageFired - fired promotion description message
      Throws:
      IllegalArgumentException - if localization key cannot be mapped to data language

    • getModuleVersion

      @Accessor(qualifier="moduleVersion", type=GETTER) public Long getModuleVersion()
      Generated method - Getter of the PromotionResult.moduleVersion attribute defined at extension promotionengineservices.
      Returns:
      the moduleVersion - applied module version

    • getOrder

      @Accessor(qualifier="order", type=GETTER) public AbstractOrderModel getOrder()
      Generated method - Getter of the PromotionResult.order attribute defined at extension promotions.
      Returns:
      the order

    • getOrderCode

      @Accessor(qualifier="orderCode", type=GETTER) public String getOrderCode()
      Generated method - Getter of the PromotionResult.orderCode attribute defined at extension promotionengineservices.
      Returns:
      the orderCode - Order code

    • getPromotion

      @Accessor(qualifier="promotion", type=GETTER) public AbstractPromotionModel getPromotion()
      Generated method - Getter of the PromotionResult.promotion attribute defined at extension promotions.
      Returns:
      the promotion - The promotion

    • getRulesModuleName

      @Accessor(qualifier="rulesModuleName", type=GETTER) public String getRulesModuleName()
      Generated method - Getter of the PromotionResult.rulesModuleName attribute defined at extension promotionengineservices.
      Returns:
      the rulesModuleName - applied rules module name

    • getRuleVersion

      @Accessor(qualifier="ruleVersion", type=GETTER) public Long getRuleVersion()
      Generated method - Getter of the PromotionResult.ruleVersion attribute defined at extension promotionengineservices.
      Returns:
      the ruleVersion - applied rule version

    • setActions

      @Accessor(qualifier="actions", type=SETTER) public void setActions(Collection<AbstractPromotionActionModel> value)
      Generated method - Setter of PromotionResult.actions attribute defined at extension promotions.
      Parameters:
      value - the actions - List of actions

    • setAllPromotionActions

      @Accessor(qualifier="allPromotionActions", type=SETTER) public void setAllPromotionActions(Set<AbstractPromotionActionModel> value)
      Generated method - Setter of PromotionResult.allPromotionActions attribute defined at extension promotions.
      Parameters:
      value - the allPromotionActions

    • setCertainty

      @Accessor(qualifier="certainty", type=SETTER) public void setCertainty(Float value)
      Generated method - Setter of PromotionResult.certainty attribute defined at extension promotions.
      Parameters:
      value - the certainty - Certainty

    • setConsumedEntries

      @Accessor(qualifier="consumedEntries", type=SETTER) public void setConsumedEntries(Collection<PromotionOrderEntryConsumedModel> value)
      Generated method - Setter of PromotionResult.consumedEntries attribute defined at extension promotions.
      Parameters:
      value - the consumedEntries - List of consumed entries

    • setCustom

      @Accessor(qualifier="custom", type=SETTER) public void setCustom(String value)
      Generated method - Setter of PromotionResult.custom attribute defined at extension promotions.
      Parameters:
      value - the custom - Custom data stored on this promotion result by the promotion.

    • setMessageFired

      @Accessor(qualifier="messageFired", type=SETTER) public void setMessageFired(String value)
      Generated method - Setter of PromotionResult.messageFired attribute defined at extension promotionengineservices.
      Parameters:
      value - the messageFired - fired promotion description message

    • setMessageFired

      @Accessor(qualifier="messageFired", type=SETTER) public void setMessageFired(String value, Locale loc)
      Generated method - Setter of PromotionResult.messageFired attribute defined at extension promotionengineservices.
      Parameters:
      value - the messageFired - fired promotion description message
      loc - the value localization key
      Throws:
      IllegalArgumentException - if localization key cannot be mapped to data language

    • setModuleVersion

      @Accessor(qualifier="moduleVersion", type=SETTER) public void setModuleVersion(Long value)
      Generated method - Setter of PromotionResult.moduleVersion attribute defined at extension promotionengineservices.
      Parameters:
      value - the moduleVersion - applied module version

    • setOrder

      @Accessor(qualifier="order", type=SETTER) public void setOrder(AbstractOrderModel value)
      Generated method - Setter of PromotionResult.order attribute defined at extension promotions.
      Parameters:
      value - the order

    • setOrderCode

      @Accessor(qualifier="orderCode", type=SETTER) public void setOrderCode(String value)
      Generated method - Setter of PromotionResult.orderCode attribute defined at extension promotionengineservices.
      Parameters:
      value - the orderCode - Order code

    • setPromotion

      @Accessor(qualifier="promotion", type=SETTER) public void setPromotion(AbstractPromotionModel value)
      Generated method - Setter of PromotionResult.promotion attribute defined at extension promotions.
      Parameters:
      value - the promotion - The promotion

    • setRulesModuleName

      @Accessor(qualifier="rulesModuleName", type=SETTER) public void setRulesModuleName(String value)
      Generated method - Setter of PromotionResult.rulesModuleName attribute defined at extension promotionengineservices.
      Parameters:
      value - the rulesModuleName - applied rules module name

    • setRuleVersion

      @Accessor(qualifier="ruleVersion", type=SETTER) public void setRuleVersion(Long value)
      Generated method - Setter of PromotionResult.ruleVersion attribute defined at extension promotionengineservices.
      Parameters:
      value - the ruleVersion - applied rule version