Package com.sap.retail.sapppspricing.swagger.businessobject.dto

Class PriceDerivationRuleBase

java.lang.Object
com.sap.retail.sapppspricing.swagger.businessobject.dto.PriceDerivationRuleBase
@Generated(value="io.swagger.codegen.v3.generators.java.JavaClientCodegen", date="2022-09-26T19:16:22.658615400+05:30[Asia/Calcutta]") public class PriceDerivationRuleBase extends Object
Contains information of an applied price derivation rule.

  • Constructor Details

    • PriceDerivationRuleBase

      public PriceDerivationRuleBase()

  • Method Details

    • priceDerivationRuleID

      public PriceDerivationRuleBase priceDerivationRuleID(String priceDerivationRuleID)

    • getPriceDerivationRuleID

      public String getPriceDerivationRuleID()
      Identifies the price derivation rule. Decimal representation of a 64 bit integer value
      Returns:
      priceDerivationRuleID

    • setPriceDerivationRuleID

      public void setPriceDerivationRuleID(String priceDerivationRuleID)

    • eligibility

      public PriceDerivationRuleBase eligibility(List<PriceDerivationRuleEligibility> eligibility)

    • addEligibilityItem

      public PriceDerivationRuleBase addEligibilityItem(PriceDerivationRuleEligibility eligibilityItem)

    • getEligibility

      public List<PriceDerivationRuleEligibility> getEligibility()
      Only relevant for of coupon eligibilities. Each coupon that is used results in a separate eligibility element.
      Returns:
      eligibility

    • setEligibility

      public void setEligibility(List<PriceDerivationRuleEligibility> eligibility)

    • any

      public PriceDerivationRuleBase any(List<Object> any)

    • addAnyItem

      public PriceDerivationRuleBase addAnyItem(Object anyItem)

    • getAny

      public List<Object> getAny()
      This is currently not supported.
      Returns:
      any

    • setAny

      public void setAny(List<Object> any)

    • promotionDescription

      public PriceDerivationRuleBase promotionDescription(String promotionDescription)

    • getPromotionDescription

      public String getPromotionDescription()
      Exists for compatibility reasons with earlier versions of the Client API (1.0). As of Client API 2.0, use PromotionDescriptionMultiLanguage instead of PromotionDescription.
      Returns:
      promotionDescription

    • setPromotionDescription

      public void setPromotionDescription(String promotionDescription)

    • promotionDescriptionMultiLanguage

      public PriceDerivationRuleBase promotionDescriptionMultiLanguage(List<DescriptionCommonData> promotionDescriptionMultiLanguage)

    • addPromotionDescriptionMultiLanguageItem

      public PriceDerivationRuleBase addPromotionDescriptionMultiLanguageItem(DescriptionCommonData promotionDescriptionMultiLanguageItem)

    • getPromotionDescriptionMultiLanguage

      public List<DescriptionCommonData> getPromotionDescriptionMultiLanguage()
      Promotion descriptions in the languages requested by the client via RequestedMultiLanguage in the ARTSHeader. Only provided with Client API version 2.0 or higher.
      Returns:
      promotionDescriptionMultiLanguage

    • setPromotionDescriptionMultiLanguage

      public void setPromotionDescriptionMultiLanguage(List<DescriptionCommonData> promotionDescriptionMultiLanguage)

    • promotionPriceDerivationRuleSequence

      public PriceDerivationRuleBase promotionPriceDerivationRuleSequence(Long promotionPriceDerivationRuleSequence)

    • getPromotionPriceDerivationRuleSequence

      public Long getPromotionPriceDerivationRuleSequence()
      This is specified in the promotion master data and controls in which order rules are applied. Line-item-related price derivation rules and transaction-related price derivation rules are treated independently (all line-item-related promotions are applied first).
      Returns:
      promotionPriceDerivationRuleSequence

    • setPromotionPriceDerivationRuleSequence

      public void setPromotionPriceDerivationRuleSequence(Long promotionPriceDerivationRuleSequence)

    • promotionPriceDerivationRuleResolution

      public PriceDerivationRuleBase promotionPriceDerivationRuleResolution(Long promotionPriceDerivationRuleResolution)

    • getPromotionPriceDerivationRuleResolution

      public Long getPromotionPriceDerivationRuleResolution()
      This is specified in the promotion master data and controls which rule is applied if several rules have the same sequence value. If there are price derivation rules with an identical sequence number and identical highest resolution, the service tries to perform a best-price calculation. It is not guaranteed that this will succeed. minimum: 0
      Returns:
      promotionPriceDerivationRuleResolution

    • setPromotionPriceDerivationRuleResolution

      public void setPromotionPriceDerivationRuleResolution(Long promotionPriceDerivationRuleResolution)

    • promotionPriceDerivationRuleTypeCode

      public PriceDerivationRuleBase promotionPriceDerivationRuleTypeCode(String promotionPriceDerivationRuleTypeCode)

    • getPromotionPriceDerivationRuleTypeCode

      public String getPromotionPriceDerivationRuleTypeCode()
      Holds the condition type if this promotion discount should be mapped into an SAP ERP or SAP S/4HANA condition record.
      Returns:
      promotionPriceDerivationRuleTypeCode

    • setPromotionPriceDerivationRuleTypeCode

      public void setPromotionPriceDerivationRuleTypeCode(String promotionPriceDerivationRuleTypeCode)

    • transactionControlBreakCode

      public PriceDerivationRuleBase transactionControlBreakCode(PriceDerivationRuleBase.TransactionControlBreakCodeEnum transactionControlBreakCode)

    • getTransactionControlBreakCode

      public PriceDerivationRuleBase.TransactionControlBreakCodeEnum getTransactionControlBreakCode()
      Indicates whether this is a line-item-related price derivation rule (PO/PC) or a transaction-related price derivation rule (SU/SP).
      Returns:
      transactionControlBreakCode

    • setTransactionControlBreakCode

      public void setTransactionControlBreakCode(PriceDerivationRuleBase.TransactionControlBreakCodeEnum transactionControlBreakCode)

    • priceDerivationRuleDescription

      public PriceDerivationRuleBase priceDerivationRuleDescription(String priceDerivationRuleDescription)

    • getPriceDerivationRuleDescription

      public String getPriceDerivationRuleDescription()
      Reserved for future use.
      Returns:
      priceDerivationRuleDescription

    • setPriceDerivationRuleDescription

      public void setPriceDerivationRuleDescription(String priceDerivationRuleDescription)

    • promotionOriginatorTypeCode

      public PriceDerivationRuleBase promotionOriginatorTypeCode(String promotionOriginatorTypeCode)

    • getPromotionOriginatorTypeCode

      public String getPromotionOriginatorTypeCode()
      Contains information about the origin of the promotion as specifed in the promotion master data.
      Returns:
      promotionOriginatorTypeCode

    • setPromotionOriginatorTypeCode

      public void setPromotionOriginatorTypeCode(String promotionOriginatorTypeCode)

    • triggerQuantity

      public PriceDerivationRuleBase triggerQuantity(BigDecimal triggerQuantity)

    • getTriggerQuantity

      public BigDecimal getTriggerQuantity()
      The total quantity that needs to be purchased in order to trigger the price derivation rule. minimum: 0
      Returns:
      triggerQuantity

    • setTriggerQuantity

      public void setTriggerQuantity(BigDecimal triggerQuantity)

    • discountMethodCode

      public PriceDerivationRuleBase discountMethodCode(String discountMethodCode)

    • getDiscountMethodCode

      public String getDiscountMethodCode()
      Determines how the discount impacts the calculation of the transaction. Possible values are: 00 - The discount reduces the transaction total. 01 - The discount does not influence the transaction total or the amount that the customer has to pay. However, the customer gets a gift certificate for the discount amount that he can use to pay for the next purchase. 02 - The discount is used as a tender for the current transaction, for example it reduces the remaining amount that the customer has to pay. 03 - The discount reduces the transaction total but is counterbalanced by some gift certificate sale. 04 - A coupon is given to the customer instead of a discount. Transaction total is not reduced.
      Returns:
      discountMethodCode

    • setDiscountMethodCode

      public void setDiscountMethodCode(String discountMethodCode)

    • frequentShopperPointsFlag

      public PriceDerivationRuleBase frequentShopperPointsFlag(Boolean frequentShopperPointsFlag)

    • isFrequentShopperPointsFlag

      public Boolean isFrequentShopperPointsFlag()
      Determines whether a discount (false) or loyalty points (true) are granted by the price derivation rule
      Returns:
      frequentShopperPointsFlag

    • setFrequentShopperPointsFlag

      public void setFrequentShopperPointsFlag(Boolean frequentShopperPointsFlag)

    • customerGroupLoyaltyPointsDefaultQuantity

      public PriceDerivationRuleBase customerGroupLoyaltyPointsDefaultQuantity(BigDecimal customerGroupLoyaltyPointsDefaultQuantity)

    • getCustomerGroupLoyaltyPointsDefaultQuantity

      public BigDecimal getCustomerGroupLoyaltyPointsDefaultQuantity()
      Reserved for future use.
      Returns:
      customerGroupLoyaltyPointsDefaultQuantity

    • setCustomerGroupLoyaltyPointsDefaultQuantity

      public void setCustomerGroupLoyaltyPointsDefaultQuantity(BigDecimal customerGroupLoyaltyPointsDefaultQuantity)

    • prohibitPrintFlag

      public PriceDerivationRuleBase prohibitPrintFlag(Boolean prohibitPrintFlag)

    • isProhibitPrintFlag

      public Boolean isProhibitPrintFlag()
      Determines if the result of the applied price derivation rule is to be suppressed on displays and accordingly not printed on the receipt. If this element is missing in the request, the default value is set to false and the applied price derivation is printed on the receipt.
      Returns:
      prohibitPrintFlag

    • setProhibitPrintFlag

      public void setProhibitPrintFlag(Boolean prohibitPrintFlag)

    • tenderTypeCode

      public PriceDerivationRuleBase tenderTypeCode(String tenderTypeCode)

    • getTenderTypeCode

      public String getTenderTypeCode()
      Type code of the tender. This value is needed only for DiscountMethodCode = 02.
      Returns:
      tenderTypeCode

    • setTenderTypeCode

      public void setTenderTypeCode(String tenderTypeCode)

    • pointsConversionAmount

      public PriceDerivationRuleBase pointsConversionAmount(AmountCommonData pointsConversionAmount)

    • getPointsConversionAmount

      public AmountCommonData getPointsConversionAmount()
      Get pointsConversionAmount
      Returns:
      pointsConversionAmount

    • setPointsConversionAmount

      public void setPointsConversionAmount(AmountCommonData pointsConversionAmount)

    • noEffectOnSubsequentPriceDerivationRulesFlag

      public PriceDerivationRuleBase noEffectOnSubsequentPriceDerivationRulesFlag(Boolean noEffectOnSubsequentPriceDerivationRulesFlag)

    • isNoEffectOnSubsequentPriceDerivationRulesFlag

      public Boolean isNoEffectOnSubsequentPriceDerivationRulesFlag()
      Determines whether applying this price derivation rule influences the calculation base of subsequent price derivation rules (false) or not (true). This is only relevant for line-item-related monetary price derivation rules.
      Returns:
      noEffectOnSubsequentPriceDerivationRulesFlag

    • setNoEffectOnSubsequentPriceDerivationRulesFlag

      public void setNoEffectOnSubsequentPriceDerivationRulesFlag(Boolean noEffectOnSubsequentPriceDerivationRulesFlag)

    • prohibitTransactionRelatedPriceDerivationRulesFlag

      public PriceDerivationRuleBase prohibitTransactionRelatedPriceDerivationRulesFlag(Boolean prohibitTransactionRelatedPriceDerivationRulesFlag)

    • isProhibitTransactionRelatedPriceDerivationRulesFlag

      public Boolean isProhibitTransactionRelatedPriceDerivationRulesFlag()
      Determines whether applying this price derivation rule influences the calculation base of subsequent transaction-related price derivation rules (false) or not (true). This is only relevant for line-item-related monetary price derivation rules.
      Returns:
      prohibitTransactionRelatedPriceDerivationRulesFlag

    • setProhibitTransactionRelatedPriceDerivationRulesFlag

      public void setProhibitTransactionRelatedPriceDerivationRulesFlag(Boolean prohibitTransactionRelatedPriceDerivationRulesFlag)

    • exclusiveFlag

      public PriceDerivationRuleBase exclusiveFlag(Boolean exclusiveFlag)

    • isExclusiveFlag

      public Boolean isExclusiveFlag()
      Determines whether this price derivation rule is an exclusive one. This impacts the application of further price derivation rules with a higher sequence.
      Returns:
      exclusiveFlag

    • setExclusiveFlag

      public void setExclusiveFlag(Boolean exclusiveFlag)

    • concurrenceControlVector

      public PriceDerivationRuleBase concurrenceControlVector(String concurrenceControlVector)

    • getConcurrenceControlVector

      public String getConcurrenceControlVector()
      This is currently not supported.
      Returns:
      concurrenceControlVector

    • setConcurrenceControlVector

      public void setConcurrenceControlVector(String concurrenceControlVector)

    • appliedCount

      public PriceDerivationRuleBase appliedCount(BigDecimal appliedCount)

    • getAppliedCount

      public BigDecimal getAppliedCount()
      Describes how often the current price derivation rule was applied.
      Returns:
      appliedCount

    • setAppliedCount

      public void setAppliedCount(BigDecimal appliedCount)

    • receiptLine

      public PriceDerivationRuleBase receiptLine(String receiptLine)

    • getReceiptLine

      public String getReceiptLine()
      Exists for compatibility reasons with earlier versions of the Client API (1.0). As of Client API 2.0, use ReceiptLineMultiLanguage instead of ReceiptLine.
      Returns:
      receiptLine

    • setReceiptLine

      public void setReceiptLine(String receiptLine)

    • receiptLineMultiLanguage

      public PriceDerivationRuleBase receiptLineMultiLanguage(List<DescriptionCommonData> receiptLineMultiLanguage)

    • addReceiptLineMultiLanguageItem

      public PriceDerivationRuleBase addReceiptLineMultiLanguageItem(DescriptionCommonData receiptLineMultiLanguageItem)

    • getReceiptLineMultiLanguage

      public List<DescriptionCommonData> getReceiptLineMultiLanguage()
      The texts to be printed on the receipt in the languages requested by the client via RequestedMultiLanguage in the ARTSHeader. Only provided with Client API version 2.0 or higher.
      Returns:
      receiptLineMultiLanguage

    • setReceiptLineMultiLanguage

      public void setReceiptLineMultiLanguage(List<DescriptionCommonData> receiptLineMultiLanguage)

    • externalPromotionID

      public PriceDerivationRuleBase externalPromotionID(String externalPromotionID)

    • getExternalPromotionID

      public String getExternalPromotionID()
      Identifies an external promotion that was the origin for the corresponding OPP promotion.
      Returns:
      externalPromotionID

    • setExternalPromotionID

      public void setExternalPromotionID(String externalPromotionID)

    • externalPriceDerivationRuleID

      public PriceDerivationRuleBase externalPriceDerivationRuleID(String externalPriceDerivationRuleID)

    • getExternalPriceDerivationRuleID

      public String getExternalPriceDerivationRuleID()
      Decimal representation of a 64 bit integer value. Not used.
      Returns:
      externalPriceDerivationRuleID

    • setExternalPriceDerivationRuleID

      public void setExternalPriceDerivationRuleID(String externalPriceDerivationRuleID)

    • couponPrintoutID

      public PriceDerivationRuleBase couponPrintoutID(String couponPrintoutID)

    • getCouponPrintoutID

      public String getCouponPrintoutID()
      The coupon number of the printout coupon. Only relevant for DiscountMethodCode = 04.
      Returns:
      couponPrintoutID

    • setCouponPrintoutID

      public void setCouponPrintoutID(String couponPrintoutID)

    • couponPrintoutRule

      public PriceDerivationRuleBase couponPrintoutRule(String couponPrintoutRule)

    • getCouponPrintoutRule

      public String getCouponPrintoutRule()
      Describes how the printout of the coupon is to be done. Only relevant for DiscountMethodCode = 04. Possible values are: 00 - A separate receipt is to be printed. 01 - The coupon is to be printed at the end of the receipt of the current transaction.
      Returns:
      couponPrintoutRule

    • setCouponPrintoutRule

      public void setCouponPrintoutRule(String couponPrintoutRule)

    • couponPrintoutText

      public PriceDerivationRuleBase couponPrintoutText(String couponPrintoutText)

    • getCouponPrintoutText

      public String getCouponPrintoutText()
      The (formatted) text to be printed. Only relevant for DiscountMethodCode = 04.
      Returns:
      couponPrintoutText

    • setCouponPrintoutText

      public void setCouponPrintoutText(String couponPrintoutText)

    • printoutValidityPeriod

      public PriceDerivationRuleBase printoutValidityPeriod(Integer printoutValidityPeriod)

    • getPrintoutValidityPeriod

      public Integer getPrintoutValidityPeriod()
      Describes for how many days the coupon will be valid. Only relevant for DiscountMethodCode = 04. minimum: 0
      Returns:
      printoutValidityPeriod

    • setPrintoutValidityPeriod

      public void setPrintoutValidityPeriod(Integer printoutValidityPeriod)

    • giftCertificateExpirationDate

      public PriceDerivationRuleBase giftCertificateExpirationDate(String giftCertificateExpirationDate)

    • getGiftCertificateExpirationDate

      public String getGiftCertificateExpirationDate()
      Reserved for future use.
      Returns:
      giftCertificateExpirationDate

    • setGiftCertificateExpirationDate

      public void setGiftCertificateExpirationDate(String giftCertificateExpirationDate)

    • externalAction

      public PriceDerivationRuleBase externalAction(ExternalActionType externalAction)

    • getExternalAction

      public ExternalActionType getExternalAction()
      Get externalAction
      Returns:
      externalAction

    • setExternalAction

      public void setExternalAction(ExternalActionType externalAction)

    • operatorDisplayText

      public PriceDerivationRuleBase operatorDisplayText(List<DescriptionCommonData> operatorDisplayText)

    • addOperatorDisplayTextItem

      public PriceDerivationRuleBase addOperatorDisplayTextItem(DescriptionCommonData operatorDisplayTextItem)

    • getOperatorDisplayText

      public List<DescriptionCommonData> getOperatorDisplayText()
      Texts shown to the operator in the languages requested by the client via RequestedMultiLanguage in the ARTSHeader. Only provided with Client API version 2.0 or higher.
      Returns:
      operatorDisplayText

    • setOperatorDisplayText

      public void setOperatorDisplayText(List<DescriptionCommonData> operatorDisplayText)

    • customerDisplayText

      public PriceDerivationRuleBase customerDisplayText(List<DescriptionCommonData> customerDisplayText)

    • addCustomerDisplayTextItem

      public PriceDerivationRuleBase addCustomerDisplayTextItem(DescriptionCommonData customerDisplayTextItem)

    • getCustomerDisplayText

      public List<DescriptionCommonData> getCustomerDisplayText()
      Texts shown to the customer in the languages requested by the client via RequestedMultiLanguage in the ARTSHeader. Only provided with Client API version 2.0 or higher.
      Returns:
      customerDisplayText

    • setCustomerDisplayText

      public void setCustomerDisplayText(List<DescriptionCommonData> customerDisplayText)

    • promotionType

      public PriceDerivationRuleBase promotionType(String promotionType)

    • getPromotionType

      public String getPromotionType()
      Can be used to control further processing on client side. Only provided with Client API version 2.0 or higher.
      Returns:
      promotionType

    • setPromotionType

      public void setPromotionType(String promotionType)

    • calculationBaseSequence

      public PriceDerivationRuleBase calculationBaseSequence(String calculationBaseSequence)

    • getCalculationBaseSequence

      public String getCalculationBaseSequence()
      The sequence value of the price derivation rule of which the result is taken as the basis for this price derivation rule. Only provided with Client API version 2.0 or higher. The type of this element is a string although its content has a numeric value. It could also contain a negative value. In that case the corresponding sign is reflected as a postfix. For example value \"-1\" is reflected in this element by type string as follows: \"1-\".
      Returns:
      calculationBaseSequence

    • setCalculationBaseSequence

      public void setCalculationBaseSequence(String calculationBaseSequence)

    • promotionID

      public PriceDerivationRuleBase promotionID(String promotionID)

    • getPromotionID

      public String getPromotionID()
      Promotion identifier. This is filled if the provided Client API version of the calculation request is 5.0 or higher. Has the same content as the PromotionID of the RetailPriceModifier etc. but should be preferred over the other fields to support cases where an applied promotion does not lead to the creation of a RetailPriceModifier, FrequentShopperPointsModifier etc.
      Returns:
      promotionID

    • setPromotionID

      public void setPromotionID(String promotionID)

    • applicationType

      public PriceDerivationRuleBase applicationType(PriceDerivationRuleBase.ApplicationTypeEnum applicationType)

    • getApplicationType

      public PriceDerivationRuleBase.ApplicationTypeEnum getApplicationType()
      Describes the type of the applied price derivation rule.
      Returns:
      applicationType

    • setApplicationType

      public void setApplicationType(PriceDerivationRuleBase.ApplicationTypeEnum applicationType)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object