com.ibm.commerce.price.commands

Class AbstractGetDynamicKitUnitPriceCmdImpl

java.lang.Object

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.TaskCommandImpl

com.ibm.commerce.price.commands.AbstractGetDynamicKitUnitPriceCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.ECTargetableCommand, com.ibm.commerce.command.TaskCommand, GetDynamicKitUnitPriceCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command

Direct Known Subclasses:

GetDynamicKitDisplayUnitPriceCmdImpl, GetDynamicKitEntitledUnitPriceCmdImpl, GetDynamicKitUnitPriceCmdImpl

public abstract class AbstractGetDynamicKitUnitPriceCmdImpl
extends com.ibm.commerce.command.TaskCommandImpl
implements GetDynamicKitUnitPriceCmd

This is the implementation of GetDynamicKitUnitPriceCmd.

The business logic is divide into two steps. Firstly adds up all entitled components' price through calculateTotalPriceOfComponents(). Then If there is a contract with PriceRuleTC, applies PriceRuleTC to dynamic kit level through calculateFinalPriceOfDynamicKit(). Here we don't consider the PriceTC.

Field Summary

Fields

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

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

defaultCommandClassName

Constructor Summary

Constructors

Constructor and Description
AbstractGetDynamicKitUnitPriceCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.Long[]	getApplicableTradingIds() Returns the identifiers of the trading agreements that were used to determine the prices for a catalog entry.
MonetaryAmount[]	getApplicableTradingUnitPrices() Returns the prices that were determined for each of the applied trading agreements for a catalog entry.
CatEntryPrices[]	getDKComponentPrices() Returns the components' price info.
boolean	getLockedPriceFromConfigurationXML() Parse the configuration xml to get the total price if the price is locked
QuantityAmount	getQuantity() Gets quantity of the dynamic kit.
java.lang.Long	getTradingId() Returns the identifier of the trading agreement which was used to calculate the best price.
MonetaryAmount	getUnitPrice() Returns the best unit price of the dynamic kit in the requested currency.
void	performExecute() The main logic to execute the command.
void	setCurrency(java.lang.String currency) Sets the desired currency to be used for the output price.
void	setDefaultConfiguration(java.lang.String defaultConfiguration) Set the configuration BOM xml of the PDC
void	setDKComponentPrices(CatEntryPrices[] componentPrices) Sets components of the dynamic kit.
void	setDynamicKitId(java.lang.Long dynamicKitId) Sets the dynamic kit id.
void	setQuantity(QuantityAmount newQuantity) Sets quantity of the dynamic kit.
void	setTradingIds(java.lang.Long[] tradingIdsIn) Sets the identifiers of the input trading agreements.
void	validateParameters() Checks mandatory parameters.

Methods inherited from class java.lang.Object

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

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

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

execute

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

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME

The name of this class.

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

AbstractGetDynamicKitUnitPriceCmdImpl

public AbstractGetDynamicKitUnitPriceCmdImpl()

Method Detail

getApplicableTradingIds

public java.lang.Long[] getApplicableTradingIds()

Description copied from interface: GetDynamicKitUnitPriceCmd

Returns the identifiers of the trading agreements that were used to determine the prices for a catalog entry.

Specified by:

getApplicableTradingIds in interface GetDynamicKitUnitPriceCmd

Returns:

The identifiers of all the trading agreements that were used to obtain the prices for the specified catalog entry. This array may be empty.

See Also:

GetDynamicKitUnitPriceCmd.getApplicableTradingIds()

getApplicableTradingUnitPrices

public MonetaryAmount[] getApplicableTradingUnitPrices()

Description copied from interface: GetDynamicKitUnitPriceCmd

Returns the prices that were determined for each of the applied trading agreements for a catalog entry. Each element in the returned array corresponds to the element at the same index in the array returned by GetDynamicKitUnitPriceCmd.getApplicableTradingIds().

Specified by:

getApplicableTradingUnitPrices in interface GetDynamicKitUnitPriceCmd

Returns:

The unit price amounts of the specified catalog entry in that each of them was determined individually for its corresponding trading agreement. This array may be empty.

See Also:

GetDynamicKitUnitPriceCmd.getApplicableTradingUnitPrices()

getDKComponentPrices

public CatEntryPrices[] getDKComponentPrices()

Description copied from interface: GetDynamicKitUnitPriceCmd

Returns the components' price info.

Specified by:

getDKComponentPrices in interface GetDynamicKitUnitPriceCmd

Returns:

Returns the components' price info.

See Also:

GetDynamicKitUnitPriceCmd.getDKComponentPrices()

getLockedPriceFromConfigurationXML

public boolean getLockedPriceFromConfigurationXML()

Parse the configuration xml to get the total price if the price is locked

Specified by:

getLockedPriceFromConfigurationXML in interface GetDynamicKitUnitPriceCmd

Returns:

true if the price is locked from the sterling configurator, false otherwise.

getQuantity

public QuantityAmount getQuantity()

Description copied from interface: GetDynamicKitUnitPriceCmd

Gets quantity of the dynamic kit.

Specified by:

getQuantity in interface GetDynamicKitUnitPriceCmd

Returns:

return the quantity of the dk

getTradingId

public java.lang.Long getTradingId()

Description copied from interface: GetDynamicKitUnitPriceCmd

Returns the identifier of the trading agreement which was used to calculate the best price.

Specified by:

getTradingId in interface GetDynamicKitUnitPriceCmd

Returns:

The identifier of the trading agreement that was used to determine the best price. This value may be null if no trading agreement was used to determine the price.

See Also:

GetDynamicKitUnitPriceCmd.getTradingId()

getUnitPrice

public MonetaryAmount getUnitPrice()

Description copied from interface: GetDynamicKitUnitPriceCmd

Returns the best unit price of the dynamic kit in the requested currency.

Specified by:

getUnitPrice in interface GetDynamicKitUnitPriceCmd

Returns:

The best unit price of the dynamic kit. If the components setted by the methodsetDKComponentPrices is null or empty, the unit price will be null.

See Also:

GetDynamicKitUnitPriceCmd.getUnitPrice()

performExecute

public void performExecute()
                    throws com.ibm.commerce.exception.ECException

The main logic to execute the command.

Specified by:

performExecute in interface com.ibm.commerce.command.ECCommand

Overrides:

performExecute in class com.ibm.commerce.command.AbstractECTargetableCommand

Throws:

com.ibm.commerce.exception.ECException

setCurrency

public void setCurrency(java.lang.String currency)

Description copied from interface: GetDynamicKitUnitPriceCmd

Sets the desired currency to be used for the output price.

This input value is optional. The default value is obtained from another source, such as CurrencyManager#getCurrency(StoreAccessBean, String, Integer).

Specified by:

setCurrency in interface GetDynamicKitUnitPriceCmd

Parameters:

currency - The currency to look up the price. If null, the default value will be used. If the supplied currency is empty or not supported for the store, a default store currency will be used.

See Also:

GetDynamicKitUnitPriceCmd.setCurrency(String)

setDefaultConfiguration

public void setDefaultConfiguration(java.lang.String defaultConfiguration)

Set the configuration BOM xml of the PDC

Specified by:

setDefaultConfiguration in interface GetDynamicKitUnitPriceCmd

Parameters:

defaultConfiguration - the configuration xml of the PDC

setDKComponentPrices

public void setDKComponentPrices(CatEntryPrices[] componentPrices)

Description copied from interface: GetDynamicKitUnitPriceCmd

Sets components of the dynamic kit.

For CatEntryPrices, you just need set catalog entry id and quantity.

Specified by:

setDKComponentPrices in interface GetDynamicKitUnitPriceCmd

Parameters:

componentPrices - The components of the dynamic kit. If null or empty, the unit price returned is zero.

See Also:

GetDynamicKitUnitPriceCmd.setDKComponentPrices(CatEntryPrices[])

setDynamicKitId

public void setDynamicKitId(java.lang.Long dynamicKitId)

Description copied from interface: GetDynamicKitUnitPriceCmd

Sets the dynamic kit id.

Specified by:

setDynamicKitId in interface GetDynamicKitUnitPriceCmd

Parameters:

dynamicKitId - The dynamic kit id can not be null.

See Also:

GetDynamicKitUnitPriceCmd.setDynamicKitId(Long)

setQuantity

public void setQuantity(QuantityAmount newQuantity)

Description copied from interface: GetDynamicKitUnitPriceCmd

Sets quantity of the dynamic kit.

Specified by:

setQuantity in interface GetDynamicKitUnitPriceCmd

Parameters:

newQuantity - the quantity of the dk

setTradingIds

public void setTradingIds(java.lang.Long[] tradingIdsIn)

Description copied from interface: GetDynamicKitUnitPriceCmd

Sets the identifiers of the input trading agreements.

Each member is entitled to a number of trading agreements (possibly zero). The trading agreements for each catalog entry are provided in one of two ways (from highest to lowest precedence):

1. This method;
2. ContractCmdUtil#getCurrentTradingAgreements(CommandContext).

This input value is optional. The default value is null.

Specified by:

setTradingIds in interface GetDynamicKitUnitPriceCmd

Parameters:

tradingIdsIn - The identifiers of the trading agreements to be used to determine the prices. If null or empty, the current or entitled trading agreements will be used as described above.

See Also:

GetDynamicKitUnitPriceCmd.setTradingIds(Long[])

validateParameters

public void validateParameters()
                        throws com.ibm.commerce.exception.ECException

Checks mandatory parameters.

Specified by:

validateParameters in interface com.ibm.commerce.command.ECCommand

Overrides:

validateParameters in class com.ibm.commerce.command.AbstractECTargetableCommand

Throws:

com.ibm.commerce.exception.ECException