com.ibm.commerce.price.commands
Interface GetBaseUnitPriceCmd

All Superinterfaces:
ECCommand, TaskCommand
All Known Implementing Classes:
GetBaseUnitPriceCmdImpl

public interface GetBaseUnitPriceCmd
extends TaskCommand

Interface for the command used for retrieving the base unit price of a product.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
           
static java.lang.String ERR_CODE_NO_PRICE
           
static java.lang.String ERRTASK_NAME
           
static java.lang.String NAME
           
 
Method Summary
 MonetaryAmount getBasePrice()
          Gets the base price of the catalog entry.
 java.lang.Long[] getContractIds()
          Get the contract IDs associated with the offer that supplied the price.
 java.sql.Timestamp getExpiryDateForCache()
          Gets an expiry date after which the price is no longer effective.
 OfferAccessBean getOffer()
          Get the offer access bean that was used to determine the price.
 java.lang.Long getOfferId()
          Get the offer Id that was used to determine the price.
 MonetaryAmount getPrice()
          Gets the actual price of the catalog entry.
 void setCatEntryId(java.lang.Long aCatEntryId)
          Sets the primary key of the catalog entry whose price is to be retrieved.
 void setContractIds(java.lang.Long[] aContractIdList)
          (Optional) Sets the contract IDs to be used to determine which offers apply.
 void setCurrency(java.lang.String aCurrency)
          (Optional) Set the currency to be used for finding the price.
 void setOfferIds(java.lang.Long[] anOfferIdList)
          (Optional) Sets the offer IDs to use for the price.
 void setQuantity(QuantityAmount aQuantityAmount)
          (Optional) Set the quantity amount of the catalog entry that is to be priced.
 void setStoreId(java.lang.Integer aStoreId)
          (Optional) Set the store Id to use for calculating the price.
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName

ERR_CODE_NO_PRICE

public static final java.lang.String ERR_CODE_NO_PRICE

ERRTASK_NAME

public static final java.lang.String ERRTASK_NAME

NAME

public static final java.lang.String NAME
Method Detail

getBasePrice

public MonetaryAmount getBasePrice()
Gets the base price of the catalog entry. The base price is the price (and currency) found for the catalog entry before any conversion. This is only set when the requested currency is different from the base currency and the base price must be converted to the requested price.
Returns:
the base price of the product.

getContractIds

public java.lang.Long[] getContractIds()
                                throws ECSystemException
Get the contract IDs associated with the offer that supplied the price.
Returns:
the contract ID(s).

getExpiryDateForCache

public java.sql.Timestamp getExpiryDateForCache()
                                         throws ECSystemException
Gets an expiry date after which the price is no longer effective. This expiry date may be used to decide when a page is deleted from the cache.
Returns:
the expiry date of this price.

getOffer

public OfferAccessBean getOffer()
Get the offer access bean that was used to determine the price.
Returns:
the offer access bean associated with the offer used to calculate the price.

getOfferId

public java.lang.Long getOfferId()
Get the offer Id that was used to determine the price.
Returns:
the offer Id.

getPrice

public MonetaryAmount getPrice()
Gets the actual price of the catalog entry. This price is in the requested currency of the shopper.
Returns:
the price of the catalog entry Id.

setCatEntryId

public void setCatEntryId(java.lang.Long aCatEntryId)
Sets the primary key of the catalog entry whose price is to be retrieved.
Parameters:
aCatEntryId - the reference number of a catalog entry.

setContractIds

public void setContractIds(java.lang.Long[] aContractIdList)
(Optional) Sets the contract IDs to be used to determine which offers apply. If no contract ID is specified then the default contract for the store is used.
Parameters:
aContractIdList - the contract IDs to use.

setCurrency

public void setCurrency(java.lang.String aCurrency)
(Optional) Set the currency to be used for finding the price. If the currency is not specified then the "negotiated" currency is used for the store Id and shopper's preferred currency. (The negotiated currency is the currency returned from the getCurrency() method of the currency manager).
Parameters:
aCurrency - the currency.

setOfferIds

public void setOfferIds(java.lang.Long[] anOfferIdList)
(Optional) Sets the offer IDs to use for the price. If no offer IDs are supplied, then the "best" of all qualifying offers will be used. If offer IDs are specified, the "best" of the specified offers will be returned.
Parameters:
anOfferIdList - the offer IDs.

setQuantity

public void setQuantity(QuantityAmount aQuantityAmount)
(Optional) Set the quantity amount of the catalog entry that is to be priced. The quantity amount helps determine which offers are valid. 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.
Parameters:
aQuantityAmount - a quantity amount.

setStoreId

public void setStoreId(java.lang.Integer aStoreId)
(Optional) Set the store Id to use for calculating the price. If the store Id is not specified then the store Id of the command context will be used.
Parameters:
aStoreId - the store Id.