com.ibm.commerce.isv.kit.tax

Class ApplyCalculationUsageTIKBaseCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.TaskCommandImpl

com.ibm.commerce.command.BusinessPolicyCommandImpl

com.ibm.commerce.order.calculation.CalculationCmdImpl

com.ibm.commerce.order.calculation.ApplyCalculationUsageCmdImpl

com.ibm.commerce.isv.kit.tax.ApplyCalculationUsageTIKBaseCmdImpl

All Implemented Interfaces:

BusinessPolicyCommand, com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, ApplyCalculationUsageTIKBaseCmd, ApplyCalculationUsageCmd, CalculationCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

Direct Known Subclasses:

ApplyCalculationUsageSalesTaxTIKCmdImpl, ApplyCalculationUsageShippingTaxTIKCmdImpl, ApplyCalculationUsageTIKCmdImpl

public class ApplyCalculationUsageTIKBaseCmdImpl
extends ApplyCalculationUsageCmdImpl
implements ApplyCalculationUsageTIKBaseCmd

The ApplyCalculationUsageTIKBaseCmdImpl Task Command Implementation is called by the OrderPrepareCmd Controller Command to set the different tax amounts (for example: GST, PST and so forth.) for each OrderItem supplied by OrderPrepare. It cannot be called directly and is instead extended by other commands for specific tax purposes

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.math.BigDecimal	BIG_DECIMAL_ZERO The big decimal zero field
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.Double	DOUBLE_ZERO The double zero field

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.isv.kit.tax.ApplyCalculationUsageTIKBaseCmd

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ApplyCalculationUsageTIKBaseCmdImpl() Constructor for ApplyCalculationUsageTIKBaseCmdImpl
ApplyCalculationUsageTIKBaseCmdImpl(int ataxType) Constructor for ApplyCalculationUsageTIKBaseCmdImpl(int ataxType)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSellerId(Item orderItem) This method is used to return the seller id that will be passed to the third party tax providers.
java.math.BigDecimal	getTotalRecyclingFee() Obtains the total recycling fee for this order.
void	performExecute() Executes main business logic of the command.
void	reset() Resets the command properties.
void	setTransactionType(char aType) This method is used to tell the tax software the type of transaction.

Methods inherited from class com.ibm.commerce.order.calculation.ApplyCalculationUsageCmdImpl

checkAppliedItems, getAppliedItems, setItems, setTaxCategoryIds

Methods inherited from class com.ibm.commerce.order.calculation.CalculationCmdImpl

getCurrency, getCustomProperties, getCustomProperty, getTimestamp, getUsageId, setCurrency, setCustomProperties, setCustomProperty, setTimestamp, setUsageId

Methods inherited from class com.ibm.commerce.command.BusinessPolicyCommandImpl

getPolicyId, getRequestProperties, setPolicyId, setRequestProperties

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

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

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

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

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.order.calculation.ApplyCalculationUsageCmd

checkAppliedItems, getAppliedItems, setItems, setTaxCategoryIds

Methods inherited from interface com.ibm.commerce.order.calculation.CalculationCmd

getCurrency, getCustomProperties, getCustomProperty, getTimestamp, getUsageId, setCurrency, setCustomProperties, setCustomProperty, setTimestamp, setUsageId

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, setCommandTarget, setCommandTargetName, setOutputProperties

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

isReadyToCallExecute

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, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

BIG_DECIMAL_ZERO

public static final java.math.BigDecimal BIG_DECIMAL_ZERO

The big decimal zero field

DOUBLE_ZERO

public static final java.lang.Double DOUBLE_ZERO

The double zero field

Constructor Detail

ApplyCalculationUsageTIKBaseCmdImpl

public ApplyCalculationUsageTIKBaseCmdImpl()

Constructor for ApplyCalculationUsageTIKBaseCmdImpl

ApplyCalculationUsageTIKBaseCmdImpl

public ApplyCalculationUsageTIKBaseCmdImpl(int ataxType)

Constructor for ApplyCalculationUsageTIKBaseCmdImpl(int ataxType)

Parameters:

ataxType - the taxType.

Method Detail

reset

public void reset()

Resets the command properties. Prepares the command for re-execution.

Specified by:

reset in interface com.ibm.websphere.command.Command

Overrides:

reset in class ApplyCalculationUsageCmdImpl

See Also:

Command.reset()

performExecute

public void performExecute()
                    throws ECException

Executes main business logic of the command.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class ApplyCalculationUsageCmdImpl

Throws:

ECException

See Also:

ECCommand.performExecute()

setTransactionType

public void setTransactionType(char aType)

This method is used to tell the tax software the type of transaction. The default type is a Sale.

Parameters:

aType - representing the type of transaction - valid values are

• 'B' - Backout a previous sale
• 'C' - Credit
• 'P' - Purchase
• 'R' - Return
• 'S' - Sale

getSellerId

public java.lang.String getSellerId(Item orderItem)
                             throws ECSystemException

This method is used to return the seller id that will be passed to the third party tax providers. This value will be passed to the TaxOrderItem object using the setSellerID() method. Also if an item is not associated with a fulfillment center then this value will be passed as the business name using the setBusinessName() method. The default behavior returns the value from the STOREENT.IDENTIFIER table for the store that the item is purchased from.

Parameters:

orderItem - representing the orderItem

Returns:

A string that will be passed to third party vendors as the setSellerID

Throws:

ECSystemException

getTotalRecyclingFee

public java.math.BigDecimal getTotalRecyclingFee()

Obtains the total recycling fee for this order. This will be a sum of the order item recycling fees.

Returns:

the total recycling fee for this order