Package de.hybris.platform.promotions.model

Class PromotionResultModel

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    CachedPromotionResultModel
    public class PromotionResultModel
extends ItemModel
    Generated model class for type PromotionResult first defined at extension promotions.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _ORDER2PROMOTIONRESULTSRELATION
      Generated relation code constant for relation Order2PromotionResultsRelation defining source attribute order in extension promotions.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String ACTIONS
      Generated constant - Attribute key of PromotionResult.actions attribute defined at extension promotions.
      static java.lang.String ALLPROMOTIONACTIONS
      Generated constant - Attribute key of PromotionResult.allPromotionActions attribute defined at extension promotions.
      static java.lang.String CERTAINTY
      Generated constant - Attribute key of PromotionResult.certainty attribute defined at extension promotions.
      static java.lang.String CONSUMEDENTRIES
      Generated constant - Attribute key of PromotionResult.consumedEntries attribute defined at extension promotions.
      static java.lang.String CUSTOM
      Generated constant - Attribute key of PromotionResult.custom attribute defined at extension promotions.
      static java.lang.String MESSAGEFIRED
      Generated constant - Attribute key of PromotionResult.messageFired attribute defined at extension promotionengineservices.
      static java.lang.String MODULEVERSION
      Generated constant - Attribute key of PromotionResult.moduleVersion attribute defined at extension promotionengineservices.
      static java.lang.String ORDER
      Generated constant - Attribute key of PromotionResult.order attribute defined at extension promotions.
      static java.lang.String ORDERCODE
      Generated constant - Attribute key of PromotionResult.orderCode attribute defined at extension promotionengineservices.
      static java.lang.String PROMOTION
      Generated constant - Attribute key of PromotionResult.promotion attribute defined at extension promotions.
      static java.lang.String RULESMODULENAME
      Generated constant - Attribute key of PromotionResult.rulesModuleName attribute defined at extension promotionengineservices.
      static java.lang.String RULEVERSION
      Generated constant - Attribute key of PromotionResult.ruleVersion attribute defined at extension promotionengineservices.

    • Constructor Summary

      Constructors 
      Constructor Description
      PromotionResultModel()
      Generated constructor - Default constructor for generic creation.
      PromotionResultModel​(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​(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context

    • Field Detail

      • _TYPECODE

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

      • _ORDER2PROMOTIONRESULTSRELATION

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

      • ACTIONS

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

      • CONSUMEDENTRIES

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

      • PROMOTION

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

      • CERTAINTY

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

      • CUSTOM

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

      • ORDER

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

      • ALLPROMOTIONACTIONS

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

      • RULESMODULENAME

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

      • MODULEVERSION

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

      • RULEVERSION

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

      • MESSAGEFIRED

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

      • ORDERCODE

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

    • Constructor Detail

      • PromotionResultModel

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

      • PromotionResultModel

        public PromotionResultModel​(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​(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:
        _owner - initial attribute declared by type Item at extension core

    • Method Detail

      • getActions

        @Accessor(qualifier="actions",
          type=GETTER)
public java.util.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 java.util.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 java.lang.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 java.util.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 java.lang.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 java.lang.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 java.lang.String getMessageFired​(java.util.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:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • getModuleVersion

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

      • getOrderCode

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

      • getRulesModuleName

        @Accessor(qualifier="rulesModuleName",
          type=GETTER)
public java.lang.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 java.lang.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​(java.util.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​(java.util.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​(java.lang.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​(java.util.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​(java.lang.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​(java.lang.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​(java.lang.String value,
                            java.util.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:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • setModuleVersion

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

      • setOrderCode

        @Accessor(qualifier="orderCode",
          type=SETTER)
public void setOrderCode​(java.lang.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​(java.lang.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​(java.lang.Long value)
        Generated method - Setter of PromotionResult.ruleVersion attribute defined at extension promotionengineservices.
        Parameters:
        value - the ruleVersion - applied rule version