com.ibm.commerce.price.commands

Class AbstractGetPriceCmdImpl

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.AbstractGetPriceCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.ECTargetableCommand, com.ibm.commerce.command.TaskCommand, GetContractSpecialPriceCmd, GetContractUnitPriceCmd, GetProductContractUnitPriceCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command

Direct Known Subclasses:

CatalogFilterGetContractUnitPriceCmdImpl, CompositeGetContractUnitPriceCmdImpl, EnsureOffersExistGetContractUnitPriceCmdImpl, PriceRuleGetContractUnitPriceCmdImpl

public abstract class AbstractGetPriceCmdImpl
extends com.ibm.commerce.command.TaskCommandImpl
implements GetContractUnitPriceCmd, GetProductContractUnitPriceCmd, GetContractSpecialPriceCmd

AbstractGetPriceCmdImpl is a base class implementation for newer versions of GetContractUnitPriceCmdImpl.

Field Summary

Fields inherited from interface com.ibm.commerce.price.commands.GetContractUnitPriceCmd

NAME

Fields inherited from interface com.ibm.commerce.price.commands.GetProductContractUnitPriceCmd

defaultCommandClassName, NAME

Fields inherited from interface com.ibm.commerce.price.commands.GetContractSpecialPriceCmd

NAME

Constructor Summary

Constructors

Constructor and Description
AbstractGetPriceCmdImpl() Constructor for PriceRuleGetContractUnitPriceCmdImpl.

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.
MonetaryAmount	getBasePrice() Returns the best price of the input catalog entry before any currency conversions.
CatEntryPrices[]	getCatEntryPrices() Returns the price related information for the input catalog entries.
com.ibm.commerce.order.objects.OfferAccessBean	getOffer() Returns the offer access bean that was used to determine the price.
java.lang.Long	getOfferId() Returns the identifier of the offer that was used to determine the price.
MonetaryAmount	getPrice() Returns the best price of the catalog entry in the requested currency.
java.lang.Integer	getStoreId() Returns the store that was set by the user, or from the command context if the user did not set one.
java.lang.Long	getTcId() Returns the identifier of the term condition which was used to calculate the best price.
java.lang.Long	getTradingId() Returns the identifier of the trading agreement which was used to calculate the best price.
void	reset() Resets this command so that it is in its default state.
void	setCatEntryId(java.lang.Long newCatEntryID) Sets the identifier of the catalog entry whose price is to be calculated.
void	setCatEntryPrices(CatEntryPrices[] newCatEntries) Sets the information of one or more catalog entries whose prices are to be calculated.
void	setCurrency(java.lang.String newCurrency) Sets the desired currency to be used for the output price.
void	setErrorMode(boolean newThrowPriceExceptions) Sets whether an exception will be thrown when the price cannot be found for the input catalog entry.
void	setMemberId(java.lang.Long newMemberID) Sets the member identifier to be used for determining which trading agreements are valid to use to calculate the price.
void	setOfferIds(java.lang.Long[] newOfferIDs) Sets the identifiers of the input offers to be used for price.
void	setOrderItemAccessBean(com.ibm.commerce.order.objects.OrderItemAccessBean orderItemAccessBean) Set an order item.
void	setOrganizationId(java.lang.Long newOrganizationID) Sets the organization identifier to be used in conjunction with the member identifier for verifying and searching for trading agreements.
void	setQuantity(QuantityAmount newQuantity) Sets the quantity of the input catalog entry that is to be priced.
void	setStoreId(java.lang.Integer newStoreID) Sets the identifier of the store to be used for calculating the price.
void	setTradingIds(java.lang.Long[] newTradingIDs) Sets the identifiers of the input trading agreements.
void	validateParameters() Checks that there is a store ID, currency, and either a single mode catalog entry or one or more batch mode catalog entries.

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, getUser, getUserId, isReadyToCallExecute, performExecute, 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, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Constructor Detail

AbstractGetPriceCmdImpl

public AbstractGetPriceCmdImpl()

Constructor for PriceRuleGetContractUnitPriceCmdImpl.

Method Detail

getApplicableTradingIds

public java.lang.Long[] getApplicableTradingIds()

Description copied from interface: GetContractUnitPriceCmd

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

If this command is used in single mode, these identifiers will reflect the trading agreements that were specified for that catalog entry. If this command is used in batch mode, then these identifiers will reflect the trading agreements that were used for the first catalog entry in the input array.

Specified by:

getApplicableTradingIds in interface GetContractSpecialPriceCmd

Specified by:

getApplicableTradingIds in interface GetContractUnitPriceCmd

Specified by:

getApplicableTradingIds in interface GetProductContractUnitPriceCmd

Returns:

The identifiers of all the trading agreements that were used to obtain the prices for the specified catalog entry. This array may be null or empty if GetContractUnitPriceCmd.getPrice() returns null.

getApplicableTradingUnitPrices

public MonetaryAmount[] getApplicableTradingUnitPrices()

Description copied from interface: GetContractUnitPriceCmd

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 GetContractUnitPriceCmd.getApplicableTradingIds().

If this command is used in single mode, these prices will reflect the prices that were found for the input catalog entry. If this command is used in batch mode, then these prices will reflect the prices that were used for the first catalog entry in the input array.

Specified by:

getApplicableTradingUnitPrices in interface GetContractSpecialPriceCmd

Specified by:

getApplicableTradingUnitPrices in interface GetContractUnitPriceCmd

Specified by:

getApplicableTradingUnitPrices in interface GetProductContractUnitPriceCmd

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 null or empty if GetContractUnitPriceCmd.getPrice() returns null.

getBasePrice

public MonetaryAmount getBasePrice()

Description copied from interface: GetContractUnitPriceCmd

Returns the best price of the input catalog entry before any currency conversions. This is only set when the requested currency is different from the base currency, in which case the base price must be converted to the requested price.

If this command is used in single mode, this price will be for the input catalog entry. If this command is used in batch mode, then this price will be for the first catalog entry in the input array.

Specified by:

getBasePrice in interface GetContractSpecialPriceCmd

Specified by:

getBasePrice in interface GetContractUnitPriceCmd

Specified by:

getBasePrice in interface GetProductContractUnitPriceCmd

Returns:

The best price found for the specified catalog entry. This value will be null if no currency conversion was performed to obtain the price in the requested currency.

getCatEntryPrices

public CatEntryPrices[] getCatEntryPrices()

Description copied from interface: GetContractUnitPriceCmd

Returns the price related information for the input catalog entries. Each element in the array will have various information set as a result of calling this command.

The following values reflect information about the best price for the catalog entry:

• CatEntryPrices.getTradingId()
• CatEntryPrices.getTcId()
• CatEntryPrices.getOfferId()
• CatEntryPrices.getOffer()
• CatEntryPrices.getBasePrice()
• CatEntryPrices.getUnitPrice()

The following values reflect information about all prices for the catalog entry:

• CatEntryPrices.getAllTradingIds()
• CatEntryPrices.getTradingTcIds()
• CatEntryPrices.getOfferIds()
• CatEntryPrices#getOffers()
• CatEntryPrices.getTradingBasePrices()
• CatEntryPrices.getTradingUnitPrices()

If this command is used in single mode, this array will contain one element corresponding to the input catalog entry. If this command is used in batch mode, then this array will contain the same catalog entry information, in the same order, as the input array.

In the latter case, the array itself is not guaranteed to be the same as the input array, and the elements are not guaranteed to be the same as those in the input array. However, for optimization purposes, they may be the same array and elements. In other words, users of this command should make no assumptions that the input array and elements are the same or different from the returned array.

Specified by:

getCatEntryPrices in interface GetContractSpecialPriceCmd

Specified by:

getCatEntryPrices in interface GetContractUnitPriceCmd

Specified by:

getCatEntryPrices in interface GetProductContractUnitPriceCmd

Returns:

The price related information of the input catalog entries. This array will not be null or empty. See GetContractUnitPriceCmd.setCatEntryPrices(com.ibm.commerce.price.commands.CatEntryPrices[]) for information on the input array.

getOffer

public com.ibm.commerce.order.objects.OfferAccessBean getOffer()

Description copied from interface: GetContractUnitPriceCmd

Returns the offer access bean that was used to determine the price.

If this command is used in single mode, this offer will be for the input catalog entry. If this command is used in batch mode, then this offer will be for the first catalog entry in the input array.

Specified by:

getOffer in interface GetContractSpecialPriceCmd

Specified by:

getOffer in interface GetContractUnitPriceCmd

Specified by:

getOffer in interface GetProductContractUnitPriceCmd

Returns:

The offer access bean associated with the offer that was used to determine the best price, or null if no offer was used or GetContractUnitPriceCmd.getPrice() returns null.

getOfferId

public java.lang.Long getOfferId()

Description copied from interface: GetContractUnitPriceCmd

Returns the identifier of the offer that was used to determine the price.

If this command is used in single mode, this offer will be for the input catalog entry. If this command is used in batch mode, then this offer will be for the first catalog entry in the input array.

Specified by:

getOfferId in interface GetContractSpecialPriceCmd

Specified by:

getOfferId in interface GetContractUnitPriceCmd

Specified by:

getOfferId in interface GetProductContractUnitPriceCmd

Returns:

The identifier of the offer that was used to determine the price, or null if no offer was used or GetContractUnitPriceCmd.getPrice() returns null.

getPrice

public MonetaryAmount getPrice()

Description copied from interface: GetContractUnitPriceCmd

Returns the best price of the catalog entry in the requested currency.

If this command is used in single mode, this price will be for the input catalog entry. If this command is used in batch mode, then this price will be for the first catalog entry in the input array.

Specified by:

getPrice in interface GetContractSpecialPriceCmd

Specified by:

getPrice in interface GetContractUnitPriceCmd

Specified by:

getPrice in interface GetProductContractUnitPriceCmd

Returns:

The best price of the catalog entry in the requested currency. This value may be null if the error mode is set to true and no price was found.

getStoreId

public java.lang.Integer getStoreId()

Returns the store that was set by the user, or from the command context if the user did not set one.

Specified by:

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

Overrides:

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

Returns:

The identifier of the store set by the user, or the one in the command context if the user did not set one. See setStoreId(java.lang.Integer) for details.

getTcId

public java.lang.Long getTcId()

Description copied from interface: GetContractUnitPriceCmd

Returns the identifier of the term condition which was used to calculate the best price.

If this command is used in single mode, this term condition will be for the input catalog entry. If this command is used in batch mode, then this term condition will be for the first catalog entry in the input array.

Specified by:

getTcId in interface GetContractSpecialPriceCmd

Specified by:

getTcId in interface GetContractUnitPriceCmd

Specified by:

getTcId in interface GetProductContractUnitPriceCmd

Returns:

The identifier of the term condition that was used to determine the best price. This value may be null if no term condition was used to determine the price or GetContractUnitPriceCmd.getPrice() returns null.

getTradingId

public java.lang.Long getTradingId()

Description copied from interface: GetContractUnitPriceCmd

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

If this command is used in single mode, this trading agreement will be for the input catalog entry. If this command is used in batch mode, then this trading agreement will be for the first catalog entry in the input array.

Specified by:

getTradingId in interface GetContractSpecialPriceCmd

Specified by:

getTradingId in interface GetContractUnitPriceCmd

Specified by:

getTradingId in interface GetProductContractUnitPriceCmd

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 or GetContractUnitPriceCmd.getPrice() returns null.

reset

public void reset()

Description copied from interface: GetContractUnitPriceCmd

Resets this command so that it is in its default state.

The original definition of this method described in com.ibm.websphere.command.Command.reset() requires that this method sets the output properties to the values they had before the execute() method was run. The original definition also requires that after calling this method, isReadyToCallExecute() method returns true.

In addition to the above, this command requires that input parameters must also be set to their original default values. For example, consider the following sequence of calls:

 GetContractUnitPriceCmd cmd = ...
 cmd.setCatEntryId(id);
 cmd.reset();
 cmd.setCatEntryPrices(catEntryPricesArray);
 

After these calls are executed, cmd will behave as though only setCatEntryPrices(CatEntryPrices[]) had been called.

Specified by:

reset in interface GetContractSpecialPriceCmd

Specified by:

reset in interface GetContractUnitPriceCmd

Specified by:

reset in interface GetProductContractUnitPriceCmd

Overrides:

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

setCatEntryId

public void setCatEntryId(java.lang.Long newCatEntryID)

Description copied from interface: GetContractUnitPriceCmd

Sets the identifier of the catalog entry whose price is to be calculated. Using this method sets up the command in single mode. If GetContractUnitPriceCmd.setCatEntryPrices(CatEntryPrices[]) is called with a non-null value, the catalog entries in that array will be used (which sets up this command in batch mode) and will override the catalog entry set by this method.

Either this method or GetContractUnitPriceCmd.setCatEntryPrices(CatEntryPrices[]) must be called with non-null parameters before executing this command. The default value is null.

Specified by:

setCatEntryId in interface GetContractSpecialPriceCmd

Specified by:

setCatEntryId in interface GetContractUnitPriceCmd

Specified by:

setCatEntryId in interface GetProductContractUnitPriceCmd

Parameters:

newCatEntryID - The identifier of the catalog entry whose price is to be calculated. If null, single mode will not be enabled and setting up batch mode by calling GetContractUnitPriceCmd.setCatEntryPrices(CatEntryPrices[]) will be required.

setCatEntryPrices

public void setCatEntryPrices(CatEntryPrices[] newCatEntries)

Description copied from interface: GetContractUnitPriceCmd

Sets the information of one or more catalog entries whose prices are to be calculated. Calling this method with a non-null, non-empty array will set up this command in batch mode and override the catalog entry set by GetContractUnitPriceCmd.setCatEntryId(Long).

See GetContractUnitPriceCmd.setTradingIds(Long[]) for a description of how the trading agreements in the CatEntryPrices specified by this method are used to determine price.

Either this method or GetContractUnitPriceCmd.setCatEntryId(Long) must be called with non-null parameters before executing this command. The default value is null.

Specified by:

setCatEntryPrices in interface GetContractSpecialPriceCmd

Specified by:

setCatEntryPrices in interface GetContractUnitPriceCmd

Parameters:

newCatEntries - The information of one or more catalog entries whose prices are to be retrieved. If null, the value from GetContractUnitPriceCmd.setCatEntryId(Long) will be used. If empty, the behavior of this command is undefined.

setCurrency

public void setCurrency(java.lang.String newCurrency)

Description copied from interface: GetContractUnitPriceCmd

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). This currency will only be used in conjunction with GetContractUnitPriceCmd.setCatEntryId(Long).

Specified by:

setCurrency in interface GetContractSpecialPriceCmd

Specified by:

setCurrency in interface GetContractUnitPriceCmd

Specified by:

setCurrency in interface GetProductContractUnitPriceCmd

Parameters:

newCurrency - 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.

setErrorMode

public void setErrorMode(boolean newThrowPriceExceptions)

Description copied from interface: GetContractUnitPriceCmd

Sets whether an exception will be thrown when the price cannot be found for the input catalog entry.

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

Specified by:

setErrorMode in interface GetContractSpecialPriceCmd

Specified by:

setErrorMode in interface GetContractUnitPriceCmd

Specified by:

setErrorMode in interface GetProductContractUnitPriceCmd

Parameters:

newThrowPriceExceptions - True indicates an exception will be thrown when a price cannot be found, false indicates exceptions will be ignored and null will be returned for the price instead.

setMemberId

public void setMemberId(java.lang.Long newMemberID)

Description copied from interface: GetContractUnitPriceCmd

Sets the member identifier to be used for determining which trading agreements are valid to use to calculate the price. See GetContractUnitPriceCmd.setTradingIds(Long[]) for details on how the trading agreements are used.

This input value is optional. The default value is obtained from CommandContext#getUserId().

Specified by:

setMemberId in interface GetContractUnitPriceCmd

Parameters:

newMemberID - The member identifier to be used to verify the input list of trading agreements. If null, the default value will be used.

setOfferIds

public void setOfferIds(java.lang.Long[] newOfferIDs)

Description copied from interface: GetContractUnitPriceCmd

Sets the identifiers of the input offers to be used for price.

This input value is optional. The default value is the list of all qualifying offers. These offers will only be used in conjunction with GetContractUnitPriceCmd.setCatEntryId(Long).

Specified by:

setOfferIds in interface GetContractSpecialPriceCmd

Specified by:

setOfferIds in interface GetContractUnitPriceCmd

Specified by:

setOfferIds in interface GetProductContractUnitPriceCmd

Parameters:

newOfferIDs - The reference number of one or more offers that are to be used for determining the price. If null or empty, then the "best" of all qualifying offers will be used. Otherwise, the "best" of the specified offers will be returned.

setOrderItemAccessBean

public void setOrderItemAccessBean(com.ibm.commerce.order.objects.OrderItemAccessBean orderItemAccessBean)

Description copied from interface: GetContractSpecialPriceCmd

Set an order item.

This value is never set or used, so implementors may safely do nothing.

Specified by:

setOrderItemAccessBean in interface GetContractSpecialPriceCmd

Parameters:

orderItemAccessBean - An order item access bean. May be null.

setOrganizationId

public void setOrganizationId(java.lang.Long newOrganizationID)

Description copied from interface: GetContractUnitPriceCmd

Sets the organization identifier to be used in conjunction with the member identifier for verifying and searching for trading agreements. This value will only be used when the member identifier provided is different from the CommandContext#getUserId().

This input value is optional. The default value is the EntitlementContext#getActiveOrganizationId().

Specified by:

setOrganizationId in interface GetContractUnitPriceCmd

Parameters:

newOrganizationID - The organization identifier to be used in conjunction with the member identifier to verify the input list of trading agreements. If null, the default value will be used.

setQuantity

public void setQuantity(QuantityAmount newQuantity)

Description copied from interface: GetContractUnitPriceCmd

Sets the quantity of the input catalog entry that is to be priced. The quantity helps determine which prices are to be used when there are multiple price ranges.

For example, consider the table below:

Quantity range	Price per unit
1-5	10 USD
6-10	9 USD

If the quantity specified by this method is 2, the price per unit will be 10 USD. If the quantity is 8, the price per unit will be 9 USD.

If the quantity amount is not specified, then the nominal quantity (rounded up to the nearest multiple as specified in the quantityMultiple attribute) of the Catalog entry is assumed to be the requested quantity. See the CATENTSHIP table for more information. This behavior can be implemented by calling RetrievePricesCmd.

This input value is optional. The default value is the nominal quantity for the catalog entry. This quantity will only be used in conjunction with GetContractUnitPriceCmd.setCatEntryId(Long).

Specified by:

setQuantity in interface GetContractSpecialPriceCmd

Specified by:

setQuantity in interface GetContractUnitPriceCmd

Specified by:

setQuantity in interface GetProductContractUnitPriceCmd

Parameters:

newQuantity - The quantity amount of the catalog entry. If null, the nominal quantity will be used as described above.

setStoreId

public void setStoreId(java.lang.Integer newStoreID)

Description copied from interface: GetContractUnitPriceCmd

Sets the identifier of the store to be used for calculating the price.

This input value is optional. The default value is CommandContext#getStoreId().

Specified by:

setStoreId in interface GetContractSpecialPriceCmd

Specified by:

setStoreId in interface GetContractUnitPriceCmd

Specified by:

setStoreId in interface GetProductContractUnitPriceCmd

Parameters:

newStoreID - The reference number of a store to be used for calculating the price. If null, the command context will be used to determine the store.

setTradingIds

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

Description copied from interface: GetContractUnitPriceCmd

Sets the identifiers of the input trading agreements.

Each member is entitled to a number of trading agreements (possibly zero), depending on the member and store. The trading agreements for each catalog entry are provided in one of three ways (from highest to lowest precedence):

1. GetContractUnitPriceCmd.setCatEntryPrices(CatEntryPrices[]) (each catalog entry can have different trading agreements defined or none);
2. This method;
3. ContractCmdUtil#getCurrentTradingAgreements(CommandContext).

The specified trading agreements will be checked against the entitled agreements for the specified member. Only the valid trading agreements will be used. If no trading agreements are specified, all entitled trading agreements will be used.

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

Specified by:

setTradingIds in interface GetContractSpecialPriceCmd

Specified by:

setTradingIds in interface GetContractUnitPriceCmd

Specified by:

setTradingIds in interface GetProductContractUnitPriceCmd

Parameters:

newTradingIDs - 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.

validateParameters

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

Checks that there is a store ID, currency, and either a single mode catalog entry or one or more batch mode catalog entries. The store ID and currencies may come from the command context and this will pass.

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 - If any of the required parameters is missing.