Package com.ibm.commerce.order.calculation
Contains classes and interfaces for handling commands related to the order subsystem, excluding those components, such as fulfillment, payment, and price, that are described elsewhere.
See: Description

Interface Summary Interface Description AdjustShippingChargesCmd This order task command is used to process the shipping adjustment objects according to the given processFlag.ApplyCalculationUsageCmd Given a calculation usage and a list of items, this command will "apply" the calculation usage to the items.ApplyShippingCmd This order task command is used to give a list of items.CalculationCmd This is the base interface that commands registered as calculation methods must extend.CalculationCodeApplyCmd Sets a calculation code, a list of items and a corresponding list of values.CalculationCodeCalculateCmd Given a calculation code and a list of items, this command will calculate the value of the calculation code for each item.CalculationCodeCombineCmd Given a calculation usage and a list of items, this command will determine the calculation codes that are attached to the items.CalculationCodeQualifyCmd Given a calculation code and a list of items, this command will determine the items that are qualified for the calculation code.CalculationConstants This interface defines various constants used by the Calculation Framework.CalculationConstants.DefaultDiscountCalculationMethodIds Default calculationMethodIds for discount.CalculationConstants.DefaultSalesTaxCalculationMethodIds Default calculationMethodIds for sales tax.CalculationConstants.DefaultShippingCalculationMethodIds Default calculationMethodIds for shipping.CalculationConstants.DefaultShippingTaxCalculationMethodIds Default calculationMethodIds for shipping tax.CalculationRangeCmd Sets a calculation range, a calculation range lookup result, a lookup number and a base monetary value.CalculationRuleCalculateCmd Given a calculation rule and a list of items, this command will calculate the value of the calculation rule for each item.CalculationRuleCombineCmd Sets a calculation code and a list of items first.CalculationRuleQualifyCmd Given a calculation rule and a list of items, commands that extend this interface will determine the items that are qualified for the calculation rule.CalculationScaleLookupCmd Set a calculation scale and a list of items first.ContractShippingAdjustmentCalculationCodeCalculateCmd This order task command is used to calculate the Contract defined shipping charge adjustment, the default CalculationCodeCalculate method for calcode_id=14.DiscountCalculationCodeApplyCmd This is the discount specific version of theCalculationCodeApply
command.DiscountCalculationCodeCombineCmd Given a calculation usage and a list of items, this command will determine the discount calculation codes that are attached to the items.DiscountCalculationRuleQualifyCmd This command is given a calculation rule and a list of items.FinalizeCalculationUsageCmd Sets a calculation usage, an order and its orderitems.FixedAmountCalculationRangeCmd Sets a calculation range, a calculation range lookup result, a lookup number and a base monetary value.GetOrderLevelParameterCmd Returns the order level attachment parameter of a particular order.InitializeAdjustmentCmd This is the discount specific version of theInitializeCalculationUsage
command.InitializeCalculationUsageCmd This command is called by OrderPrepare/PrepareOrder to initialize a calculation usage.InitializeSalesTaxCmd This is the sales tax specific version of the InitializeCalculationUsage command.InitializeShippingCmd This is the shipping specific version of the InitializeCalculationUsage command.InitializeShippingTaxCmd This is the shipping tax specific version of the InitializeCalculationUsage command.NetPriceCalculationScaleLookupCmd This version of theCalculationScaleLookup
command is intended for calculation scales that are based on net price.NetPriceWithQuantityAsResultMultiplierCalculationScaleLookupCmd This version of theCalculationScaleLookup
command is intended for calculation scales that are based on net price.NetShippingCalculationScaleLookupCmd This version of theCalculationScaleLookup
command is intended for calculation scales that are based on net shipping charge.NonDiscountedPriceCalculationScaleLookupCmd This version of theCalculationScaleLookup
command is intended for calculation scales that are based on nondiscounted price.PercentageCalculationRangeCmd This version of theCalculationRange
command returns the calculation range lookup result multiplied by the base monetary value then divided by 100.PerUnitAmountCalculationRangeCmd This version of theCalculationRange
command returns the calculation range lookup result multiplied by the lookup number.QuantityCalculationScaleLookupCmd This version of theCalculationScaleLookup
command is intended for calculation scales that are based on quantity.QuantitySpreadByNetPriceCalculationScaleLookupCmd This version of theCalculationScaleLookup
command is intended for calculation scales that are based on quantity.ResolveJurisdictionsCmd This is the base interface of the following commands:
ResolveShippingJurisdictions
ResolveTaxJurisdictions
ResolveShippingJurisdictionsCmd This command resolves an address into a list of shipping jurisdictions.ResolveTaxJurisdictionsCmd This command resolves an address into a list of tax jurisdictions.SalesTaxCalculationCodeApplyCmd This is the sales tax specific version of theCalculationCodeApply
command.ServiceAdjustShippingChargesCmd Interface for theServiceAdjustShippingChargesCmd
Controller Command that captures a Service Representatives adjustment value so it may be evaluated during recalculation.SetOrderLevelParameterCmd Sets the order level attachment parameter of a particular order.ShipModeShippingAdjustmentCalculationCodeCalculateCmd This order task command is used to calculate the TSR shipmode level overriding shipping charge delegation.ShippingAdjustmentCalculationCodeCombineCmd The ShippingAdjustmentCalculationCodeCombineCmd is used to combine the calculation code for Shipping Adjustment calculation usage.ShippingCalculationCodeApplyCmd This is the shipping specific version of theCalculationCodeApply
command.ShippingCalculationRuleQualifyCmd This is the shipping specific version of theCalculationRuleQualify
command.ShippingTaxCalculationCodeApplyCmd This is the shipping tax specific version of theCalculationCodeApply
command.SummarizeAdjustmentCmd This is the discount specific version of theSummarizeCalculationUsage
command.SummarizeCalculationUsageCmd This command is called by OrderPrepare/PrepareOrder to summarize a calculation usage.SummarizeSalesTaxCmd This is the sales tax specific version of theSummarizeCalculationUsage
command.SummarizeShippingCmd This is the shipping specific version of theSummarizeCalculationUsage
command.SummarizeShippingTaxCmd This is the shipping tax specific version of theSummarizeCalculationUsage
command.TaxableNetPriceCalculationScaleLookupCmd This version of theCalculationScaleLookup
command is intended for calculation scales that are based on taxable net price.TaxableNetPricePlusNetShippingCalculationScaleLookupCmd This version of theCalculationScaleLookup
command is intended for calculation scales that are based on taxable net price plus net shipping charge.TaxableNetPriceTaxOnTaxCalculationScaleLookupCmd The command calculates the following values: Base monetary value The sum of the taxable net prices of OrderItems plus any previous taxes applied.
TaxableUnitPriceCalculationScaleLookupCmd This version of theCalculationScaleLookup
command is intended for calculation scales that are based on taxable unit price.TaxableUnitPricePlusUnitShippingCalculationScaleLookupCmd This version of theCalculationScaleLookup
command is intended for calculation scales that are based on taxable unit price plus unit shipping charge.TaxCalculationCodeCombineCmd This is the sales tax and shipping tax specific version of theCalculationCodeCombine
command.TaxCalculationRuleQualifyCmd This is the sales tax and shipping tax specific version of theCalculationRuleQualify
command.UnitPriceCalculationScaleLookupCmd This version of theCalculationScaleLookup
command is intended for calculation scales that are based on unit price.UnitShippingCalculationScaleLookupCmd This version of theCalculationScaleLookup
command is intended for calculation scales that are based on unit shipping charge.VATCalculationRuleCombineCmd This command is used to calculate sales tax and shipping tax when VAT(ValueAddedTax) feature is enabled.WeightCalculationScaleLookupCmd This version of theCalculationScaleLookup
command is intended for calculation scales that are based on physical weight.WeightSpreadByNetPriceCalculationScaleLookupCmd This version of theCalculationScaleLookup
command is intended for calculation scales that are based on physical weight. 
Class Summary Class Description AdjustShippingChargesCmdImpl This is the default implementation of theAdjustShippingChargesCmd
task command.ApplyCalculationUsageCmdImpl The default implementation ofApplyCalculationUsageCmd
.ApplyShippingChargeByCarrierCmdImpl This is an implementation ofApplyCalculationUsageCmd
for the bootstrap business policy "ShippingChargeByCarrier".ApplyShippingCmdImpl This is the default implementation ofApplyShippingCmd
.ApplyStandardShippingChargeBySellerCmdImpl This is an implementation ofApplyCalculationUsageCmd
for the bootstrap business policyCache An abstract class for implementingCalculationCmdImpl This is an abstract command implementation that implements the base interfaceCalculationCmd
.CalculationCodeCalculateCmdImpl The default implementation ofCalculationCodeCalculateCmd
.CalculationCodeCombineCmdImpl The default implementation ofCalculationCodeCombineCmd
.CalculationCodeQualifyCmdImpl The default implementation ofCalculationCodeQualifyCmd
.CalculationHelper This class defines various helper methods used by the Calculation Framework.CalculationRegistry This registry caches tables referenced by the Calculation Framework.CalculationRuleCalculateCmdImpl The default implementation ofCalculationRuleCalculateCmd
.CalculationRuleCombineCmdImpl The default implementation ofCalculationRuleCombineCmd
.CodeCache This class caches calculation codes by calculation code ID.CodeComparator A comparator class for ordering calculation codes.CodeDescriptionCache This class caches calculation codes descriptions by calculation code ID.CodeMemberGroupRelationshipCache This class caches related member group IDs by calculation code ID.CodeTaxExemptionCache A class that caches exempted tax category IDs by calculation code ID.ContractShippingAdjustmentCalculationCodeCalculateCmdImpl This is the default implementation of theContractShippingAdjustmentCalculationCodeCalculateCmd
task command.DescendingOrderComparator A comparator for ordering objects in descending order.DirectAttachmentHelper A helper class for retrieving and caching direct attachments.DiscountCalculationCodeApplyCmdImpl The default implementation ofDiscountCalculationCodeApplyCmd
.DiscountCalculationCodeCombineCmdImpl The default implementation ofCalculationCodeCombineCmd
.DiscountCalculationRuleQualifyCmdImpl The default implementation ofDiscountCalculationRuleQualifyCmd
.FixedAmountCalculationRangeCmdImpl The default implementation ofFixedAmountCalculationRangeCmd
.GetOrderLevelParameterCmdImpl Reserved for IBM Internal use.Group Each group is composed of:
a calculation code a list ofitems
an optional list of values for each tax categoryGroupKey Key class for Group.IndirectAttachmentCache Caches tables CATENCALCD and CATGPCALCD.IndirectAttachmentHelper The utility class for indirect attachment.IndirectAttachmentKey Key class for IndirectAttachment.InitializeAdjustmentCmdImpl This is the default implementation of theInitializeAdjustment
command.InitializeSalesTaxCmdImpl This is the default implementation of theInitializeShippingCmdImpl This is the default implementation of theInitializeShippingTaxCmdImpl This is the default implementation of theItem This is an OrderItemAccessBean wrapper.ItemTaxInfo This is a data object to record the order item's tax information.LookupResultCache Caches the CALRLOOKUP table.MethodCache Caches the CALMETHOD table.MigrationHelper Helper class for migration.NetPriceCalculationScaleLookupCmdImpl This is the default implementation of theNetPriceCalculationScaleLookup
command.NetPriceWithQuantityAsResultMultiplierCalculationScaleLookupCmdImpl This is the default implementation of theNetPriceWithQuantityAsResultMultiplierCalculationScaleLookup
command.NetShippingCalculationScaleLookupCmdImpl This is the default implementation of theNetShippingCalculationScaleLookup
command.NonDiscountedPriceCalculationScaleLookupCmdImpl This is the default implementation of theNonDiscountedPriceCalculationScaleLookup
command.OrderCodeKey Index of the ORDCALCD table.OrderItemAdjustmentCache A class that caches OrderItemAdjustments by OrderItemId.PercentageCalculationRangeCmdImpl This is the default implementation of thePercentageCalculationRange
command.PerUnitAmountCalculationRangeCmdImpl This is the default implementation of thePerUnitAmountCalculationRange
command.QuantityCalculationScaleLookupCmdImpl This is the default implementation of theQuantityCalculationScaleLookup
command.QuantitySpreadByNetPriceCalculationScaleLookupCmdImpl This is the default implementation of theQuantitySpreadByNetPriceCalculationScaleLookup
command.RangeCache Caches the CALRANGE table.ResolveJurisdictionsCmdImpl This is the base implementation of the following commands:
ResolveShippingJurisdictions
ResolveTaxJurisdictions
ResolveShippingJurisdictionsCmdImpl This is the default implementation of theResolveShippingJurisdictions
command.ResolveTaxJurisdictionsCmdImpl This is the default implementation of theResolveTaxJurisdictions
command.RuleCache Caches the CALRULE table.RuleMemberGroupRelationshipCache Caches the CALRULEMGP table.RuleScaleRelationshipCache Caches the CRULESCALE table.SalesTaxCalculationCodeApplyCmdImpl This is the default implementation of theSalesTaxCalculationCodeApply
command.ScaleCache Caches the CALSCALE table.ServiceAdjustShippingChargesCmdImpl This is the default implementation of theServiceAdjustShippingChargesCmd
controller command.SetOrderLevelParameterCmdImpl This is the default implementation of theSetOrderLevelParameter
command.ShipModeShippingAdjustmentCalculationCodeCalculateCmdImpl This is the default implementation of the <> task command. ShippingAdjustmentCalculationCodeCombineCmdImpl The default implementation ofShippingAdjustmentCalculationCodeCombineCmd
.ShippingCalculationCodeApplyCmdImpl This is the default implementation of theShippingCalculationCodeApply
command.ShippingCalculationRuleQualifyCmdImpl This is the default implementation of theShippingCalculationRuleQualify
command.ShippingRuleCache Caches the SHPJCRULE table.ShippingRuleKey Index of the SHPJCRULE table.ShippingTaxCalculationCodeApplyCmdImpl This is the default implementation of theShippingTaxCalculationCodeApply
command.StoreEntityUsageCache Caches the STENCALUSG table.StoreEntityUsageKey Index of the STENCALUSG table.SubOrderAdjustmentKey Index of the SUBORDADJ table.SummarizeAdjustmentCmdImpl This is the default implementation of theSummarizeAdjustment
command.SummarizeSalesTaxCmdImpl This is the default implementation of theSummarizeSalesTax
command.SummarizeShippingCmdImpl This is the default implementation of theSummarizeShipping
command.SummarizeShippingTaxCmdImpl This is the default implementation of theSummarizeShippingTax
command.TaxableNetPriceCalculationScaleLookupCmdImpl This is the default implementation of theTaxableNetPriceCalculationScaleLookup
command.TaxableNetPricePlusNetShippingCalculationScaleLookupCmdImpl This is the default implementation of theTaxableNetPricePlusNetShippingCalculationScaleLookup
command.TaxableNetPriceTaxOnTaxCalculationScaleLookupCmdImpl The command calculates the following values: Base monetary value The sum of the taxable net prices of OrderItems plus any previous taxes applied.
TaxableUnitPriceCalculationScaleLookupCmdImpl This is the default implementation of theTaxableUnitPriceCalculationScaleLookup
command.TaxableUnitPricePlusUnitShippingCalculationScaleLookupCmdImpl This is the default implementation of theTaxableUnitPricePlusUnitShippingCalculationScaleLookup
command.TaxCalculationCodeApplyCmdImpl This is the base implementation of the following commands:
SalesTaxCalculationCodeApply
ShippingTaxCalculationCodeApply
TaxCalculationCodeCombineCmdImpl This is the default implementation of theTaxCalculationCodeCombine
command.TaxCalculationRuleQualifyCmdImpl This is the default implementation of theTaxCalculationRuleQualify
command.TaxCategoryIdCache Caches the TAXCGRY table.TaxCategoryIdKey Index of the TAXCGRY table.TaxRuleCache Caches the TAXJCRULE table.TaxRuleKey Index of the TAXJCRULE table.TaxTypeCache This class caches TaxTypes by CalculationUsage/TaxType ID.UnitPriceCalculationScaleLookupCmdImpl This is the default implementation of theUnitPriceCalculationScaleLookup
command.UnitShippingCalculationScaleLookupCmdImpl This is the default implementation of theUnitShippingCalculationScaleLookup
command.UsageSequenceCache Caches the STENCALUSG table.VATCalculationRuleCombineCmdImpl The default implementation ofVATCalculationRuleCombineCmd
.WeightCalculationScaleLookupCmdImpl This is the default implementation of theWeightCalculationScaleLookup
command.WeightSpreadByNetPriceCalculationScaleLookupCmdImpl This is the default implementation of theWeightSpreadByNetPriceCalculationScaleLookup
command.
Package com.ibm.commerce.order.calculation Description
Contains classes and interfaces for handling commands related to the order subsystem, excluding those components, such as fulfillment, payment, and price, that are described elsewhere.