com.ibm.commerce.order.calculation

Interface CalculationCmd

All Superinterfaces:

BusinessPolicyCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand

All Known Subinterfaces:

ApplyCalculationUsageCmd, ApplyCalculationUsageSalesTaxTIKCmd, ApplyCalculationUsageShippingTaxTIKCmd, ApplyCalculationUsageTIKBaseCmd, ApplyCalculationUsageTIKCmd, ApplyCouponUsageCmd, ApplyShippingCmd, CalculationCodeApplyCmd, CalculationCodeCalculateCmd, CalculationCodeCombineCmd, CalculationCodeQualifyCmd, CalculationRangeCmd, CalculationRuleCalculateCmd, CalculationRuleCombineCmd, CalculationRuleQualifyCmd, CalculationScaleLookupCmd, ContractShippingAdjustmentCalculationCodeCalculateCmd, DiscountCalculationCodeApplyCmd, DiscountCalculationCodeCombineCmd, DiscountCalculationRuleQualifyCmd, FinalizeCalculationUsageCmd, FinalizeCouponUsageCmd, FixedAmountCalculationRangeCmd, InitializeAdjustmentCmd, InitializeCalculationUsageCmd, InitializeCouponUsageCmd, InitializeSalesTaxCmd, InitializeShippingCmd, InitializeShippingTaxCmd, NetPriceCalculationScaleLookupCmd, NetPriceWithQuantityAsResultMultiplierCalculationScaleLookupCmd, NetShippingCalculationScaleLookupCmd, NonDiscountedPriceCalculationScaleLookupCmd, PercentageCalculationRangeCmd, PerUnitAmountCalculationRangeCmd, QuantityCalculationScaleLookupCmd, QuantitySpreadByNetPriceCalculationScaleLookupCmd, SalesTaxCalculationCodeApplyCmd, ShipModeShippingAdjustmentCalculationCodeCalculateCmd, ShippingAdjustmentCalculationCodeCombineCmd, ShippingCalculationCodeApplyCmd, ShippingCalculationRuleQualifyCmd, ShippingTaxCalculationCodeApplyCmd, SummarizeAdjustmentCmd, SummarizeCalculationUsageCmd, SummarizeCouponUsageCmd, SummarizeSalesTaxCmd, SummarizeShippingCmd, SummarizeShippingTaxCmd, TaxableNetPriceCalculationScaleLookupCmd, TaxableNetPricePlusNetShippingCalculationScaleLookupCmd, TaxableNetPriceTaxOnTaxCalculationScaleLookupCmd, TaxableUnitPriceCalculationScaleLookupCmd, TaxableUnitPricePlusUnitShippingCalculationScaleLookupCmd, TaxCalculationCodeCombineCmd, TaxCalculationRuleQualifyCmd, TaxCalculationUsageTIKCmd, UnitPriceCalculationScaleLookupCmd, UnitShippingCalculationScaleLookupCmd, VATCalculationRuleCombineCmd, WeightCalculationScaleLookupCmd, WeightSpreadByNetPriceCalculationScaleLookupCmd

All Known Implementing Classes:

ApplyCalculationUsageCmdImpl, ApplyCalculationUsageSalesTaxTIKCmdImpl, ApplyCalculationUsageShippingTaxTIKCmdImpl, ApplyCalculationUsageTIKBaseCmdImpl, ApplyCalculationUsageTIKCmdImpl, ApplyCouponUsageCmdImpl, ApplyShippingChargeByCarrierCmdImpl, ApplyShippingCmdImpl, ApplyStandardShippingChargeBySellerCmdImpl, CalculateDiscountAmtCmdImpl, CalculationCmdImpl, CalculationCodeCalculateCmdImpl, CalculationCodeCombineCmdImpl, CalculationCodeQualifyCmdImpl, CalculationRuleCalculateCmdImpl, CalculationRuleCombineCmdImpl, ContractShippingAdjustmentCalculationCodeCalculateCmdImpl, DiscountCalculationCodeApplyCmdImpl, DiscountCalculationCodeCombineCmdImpl, DiscountCalculationRuleQualifyCmdImpl, FinalizeCouponUsageCmdImpl, FixedAmountCalculationRangeCmdImpl, InitializeAdjustmentCmdImpl, InitializeCouponUsageCmdImpl, InitializeSalesTaxCmdImpl, InitializeShippingCmdImpl, InitializeShippingTaxCmdImpl, NetPriceCalculationScaleLookupCmdImpl, NetPriceWithQuantityAsResultMultiplierCalculationScaleLookupCmdImpl, NetShippingCalculationScaleLookupCmdImpl, NonDiscountedPriceCalculationScaleLookupCmdImpl, PercentageCalculationRangeCmdImpl, PerUnitAmountCalculationRangeCmdImpl, com.ibm.commerce.order.calculation.PromotionEngineDiscountCalculationCodeCombineCmdImpl, QuantityCalculationScaleLookupCmdImpl, QuantitySpreadByNetPriceCalculationScaleLookupCmdImpl, SalesTaxCalculationCodeApplyCmdImpl, ShipModeShippingAdjustmentCalculationCodeCalculateCmdImpl, ShippingAdjustmentCalculationCodeCombineCmdImpl, ShippingCalculationCodeApplyCmdImpl, ShippingCalculationRuleQualifyCmdImpl, ShippingTaxCalculationCodeApplyCmdImpl, SummarizeAdjustmentCmdImpl, SummarizeCouponUsageCmdImpl, SummarizeSalesTaxCmdImpl, SummarizeShippingCmdImpl, SummarizeShippingTaxCmdImpl, TaxableNetPriceCalculationScaleLookupCmdImpl, TaxableNetPricePlusNetShippingCalculationScaleLookupCmdImpl, TaxableNetPriceTaxOnTaxCalculationScaleLookupCmdImpl, TaxableUnitPriceCalculationScaleLookupCmdImpl, TaxableUnitPricePlusUnitShippingCalculationScaleLookupCmdImpl, TaxCalculationCodeApplyCmdImpl, TaxCalculationCodeCombineCmdImpl, TaxCalculationRuleQualifyCmdImpl, TaxCalculationUsageTIKCmdImpl, UnitPriceCalculationScaleLookupCmdImpl, UnitShippingCalculationScaleLookupCmdImpl, VATCalculationRuleCombineCmdImpl, 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

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The IBM copyright notice field.
static java.lang.String	NAME The name of this interface.

Fields inherited from interface com.ibm.commerce.command.CacheableECCommand

defaultCommandClassName

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from interface com.ibm.commerce.command.BusinessPolicyCommand

getPolicyId, getRequestProperties, setPolicyId, setRequestProperties

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

The IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of this interface.

See Also:

Constant Field Values

Method Detail

getCurrency

java.lang.String getCurrency()

Returns the currency to use during execution.

Returns:

the currency.

getCustomProperties

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

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

java.sql.Timestamp getTimestamp()

Returns the timestamp to use during execution.

Returns:

the timestamp.

getUsageId

java.lang.Integer getUsageId()

Returns the calculation usage.

Returns:

the calculation usage ID.

setCurrency

void setCurrency(java.lang.String astrCurrency)

Sets the currency to use during execution.

Parameters:

astrCurrency - the currency.

setCustomProperties

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

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

void setTimestamp(java.sql.Timestamp aTimestamp)

Sets the timestamp to use during execution.

Parameters:

aTimestamp - the timestamp.

setUsageId

void setUsageId(java.lang.Integer anUsageId)

Sets the calculation usage.

Parameters:

anUsageId - the calculation usage ID.