com.ibm.commerce.order.calculation
Interface CalculationCmd
- All Superinterfaces:
- BusinessPolicyCommand, TaskCommand
- All Known Subinterfaces:
- ApplyCalculationUsageCmd, ApplyCouponUsageCmd, ApplyShippingCmd, CalculationCodeApplyCmd, CalculationCodeCalculateCmd, CalculationCodeCombineCmd, CalculationCodeQualifyCmd, CalculationRangeCmd, CalculationRuleCalculateCmd, CalculationRuleCombineCmd, CalculationRuleQualifyCmd, CalculationScaleLookupCmd, DiscountCalculationCodeApplyCmd, DiscountCalculationCodeCombineCmd, DiscountCalculationRuleQualifyCmd, FinalizeCalculationUsageCmd, FinalizeCouponUsageCmd, FixedAmountCalculationRangeCmd, InitializeAdjustmentCmd, InitializeCalculationUsageCmd, InitializeCouponUsageCmd, InitializeSalesTaxCmd, InitializeShippingCmd, InitializeShippingTaxCmd, NetPriceCalculationScaleLookupCmd, NetPriceWithQuantityAsResultMultiplierCalculationScaleLookupCmd, NetShippingCalculationScaleLookupCmd, NonDiscountedPriceCalculationScaleLookupCmd, PercentageCalculationRangeCmd, PerUnitAmountCalculationRangeCmd, QuantityCalculationScaleLookupCmd, QuantitySpreadByNetPriceCalculationScaleLookupCmd, SalesTaxCalculationCodeApplyCmd, ShippingCalculationCodeApplyCmd, ShippingCalculationRuleQualifyCmd, ShippingTaxCalculationCodeApplyCmd, SummarizeAdjustmentCmd, SummarizeCalculationUsageCmd, SummarizeCouponUsageCmd, SummarizeSalesTaxCmd, SummarizeShippingCmd, SummarizeShippingTaxCmd, TaxableNetPriceCalculationScaleLookupCmd, TaxableNetPricePlusNetShippingCalculationScaleLookupCmd, TaxableUnitPriceCalculationScaleLookupCmd, TaxableUnitPricePlusUnitShippingCalculationScaleLookupCmd, TaxCalculationCodeCombineCmd, TaxCalculationRuleQualifyCmd, TaxCalculationUsageTIKCmd, UnitPriceCalculationScaleLookupCmd, UnitShippingCalculationScaleLookupCmd, WeightCalculationScaleLookupCmd, WeightSpreadByNetPriceCalculationScaleLookupCmd
- All Known Implementing Classes:
- ApplyCalculationUsageCmdImpl, ApplyCouponUsageCmdImpl, ApplyShippingChargeByCarrierCmdImpl, ApplyShippingCmdImpl, CalculationCmdImpl, CalculationCodeCalculateCmdImpl, CalculationCodeCombineCmdImpl, CalculationCodeQualifyCmdImpl, CalculationRuleCalculateCmdImpl, CalculationRuleCombineCmdImpl, DiscountCalculationCodeApplyCmdImpl, DiscountCalculationCodeCombineCmdImpl, DiscountCalculationRuleQualifyCmdImpl, FinalizeCouponUsageCmdImpl, FixedAmountCalculationRangeCmdImpl, InitializeAdjustmentCmdImpl, InitializeCouponUsageCmdImpl, InitializeSalesTaxCmdImpl, InitializeShippingCmdImpl, InitializeShippingTaxCmdImpl, NetPriceCalculationScaleLookupCmdImpl, NetPriceWithQuantityAsResultMultiplierCalculationScaleLookupCmdImpl, NetShippingCalculationScaleLookupCmdImpl, NonDiscountedPriceCalculationScaleLookupCmdImpl, PercentageCalculationRangeCmdImpl, PerUnitAmountCalculationRangeCmdImpl, QuantityCalculationScaleLookupCmdImpl, QuantitySpreadByNetPriceCalculationScaleLookupCmdImpl, SalesTaxCalculationCodeApplyCmdImpl, ShippingCalculationCodeApplyCmdImpl, ShippingCalculationRuleQualifyCmdImpl, ShippingTaxCalculationCodeApplyCmdImpl, SummarizeAdjustmentCmdImpl, SummarizeCouponUsageCmdImpl, SummarizeSalesTaxCmdImpl, SummarizeShippingCmdImpl, SummarizeShippingTaxCmdImpl, TaxableNetPriceCalculationScaleLookupCmdImpl, TaxableNetPricePlusNetShippingCalculationScaleLookupCmdImpl, TaxableUnitPriceCalculationScaleLookupCmdImpl, TaxableUnitPricePlusUnitShippingCalculationScaleLookupCmdImpl, TaxCalculationCodeApplyCmdImpl, TaxCalculationCodeCombineCmdImpl, TaxCalculationRuleQualifyCmdImpl, TaxCalculationUsageTIKCmdImpl, UnitPriceCalculationScaleLookupCmdImpl, UnitShippingCalculationScaleLookupCmdImpl, WeightCalculationScaleLookupCmdImpl, WeightSpreadByNetPriceCalculationScaleLookupCmdImpl
- public interface CalculationCmd
- extends BusinessPolicyCommand
This is the base interface that commands registered as calculation methods must extend.
A calculation method is essentially a command that can be referenced by components of the Calculation Framework. For example, a calculation code relies on the calculation methods for qualifications and calculations.
For the complete list of calculation methods, refer to the CALMETHOD table.
Field Summary |
static java.lang.String |
COPYRIGHT
The IBM copyright notice field. |
static java.lang.String |
NAME
The name of this interface. |
Method Summary |
java.lang.String |
getCurrency()
Returns the currency to use during execution. |
java.util.HashMap |
getCustomProperties()
Returns the custom properties as a HashMap. |
java.lang.Object |
getCustomProperty(java.lang.String astrName)
Returns the value of a custom property. |
java.sql.Timestamp |
getTimestamp()
Returns the timestamp to use during execution. |
java.lang.Integer |
getUsageId()
Returns the calculation usage. |
void |
setCurrency(java.lang.String astrCurrency)
Sets the currency to use during execution. |
void |
setCustomProperties(java.util.HashMap ahshCustomProperties)
Sets the custom properties. |
void |
setCustomProperty(java.lang.String astrName, java.lang.Object aValue)
Sets the value of a custom property. |
void |
setTimestamp(java.sql.Timestamp aTimestamp)
Sets the timestamp to use during execution. |
void |
setUsageId(java.lang.Integer anUsageId)
Sets the calculation usage. |
COPYRIGHT
public static final java.lang.String COPYRIGHT
- The IBM copyright notice field.
- See Also:
- Constant Field Values
NAME
public static final java.lang.String NAME
- The name of this interface.
- See Also:
- Constant Field Values
getCurrency
public java.lang.String getCurrency()
- Returns the currency to use during execution.
-
- Returns:
- the currency.
getCustomProperties
public java.util.HashMap getCustomProperties()
- Returns the custom properties as a HashMap.
-
- Returns:
- the custom properties. Key: property name (class: String). Value: property value (class: Object).
getCustomProperty
public java.lang.Object getCustomProperty(java.lang.String astrName)
- Returns the value of a custom property.
-
- Parameters:
- astrName - the property name.
- Returns:
- the property value.
getTimestamp
public java.sql.Timestamp getTimestamp()
- Returns the timestamp to use during execution.
-
- Returns:
- the timestamp.
getUsageId
public java.lang.Integer getUsageId()
- Returns the calculation usage.
-
- Returns:
- the calculation usage ID.
setCurrency
public void setCurrency(java.lang.String astrCurrency)
- Sets the currency to use during execution.
-
- Parameters:
- astrCurrency - the currency.
setCustomProperties
public void setCustomProperties(java.util.HashMap ahshCustomProperties)
- Sets the custom properties.
-
- Parameters:
- ahshCustomProperties - the custom properties. Key: property name (class: String). Value: property value (class: Object).
setCustomProperty
public void setCustomProperty(java.lang.String astrName,
java.lang.Object aValue)
- Sets the value of a custom property.
-
- Parameters:
- astrName - the property name.
- aValue - the property value.
setTimestamp
public void setTimestamp(java.sql.Timestamp aTimestamp)
- Sets the timestamp to use during execution.
-
- Parameters:
- aTimestamp - the timestamp.
setUsageId
public void setUsageId(java.lang.Integer anUsageId)
- Sets the calculation usage.
-
- Parameters:
- anUsageId - the calculation usage ID.
Feedback
(C) Copyright IBM Corporation 1996, 2005. All Rights Reserved.