com.ibm.commerce.price.commands
Interface RetrievePricesCmd

All Superinterfaces:
BusinessPolicyCommand, ECCommand, TaskCommand
All Known Implementing Classes:
RetrievePricesCmdImpl

public interface RetrievePricesCmd
extends BusinessPolicyCommand

Interface for the RetrievePricesCmd Task Command to retrieve all the qualified contract prices and to calculate the price adjustment specified by the contract for one or more catalog entries.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
           
static java.lang.String NAME
           
 
Method Summary
 java.util.Hashtable[] getItemOffers()
          Returns all the qualified offers retrieved for each of the input items.
 void setCatEntryIds(java.lang.Long[] aCatEntryIds)
          Sets the ids of the input catalog entries for retrieving the offers.
 void setCurrency(java.lang.String astrCurrency)
          Sets the currency to be used for finding the price (Optional).
 void setOfferIds(java.lang.Long[] aOfferIds)
          Sets the ids of the input offers to be used for retrieving the offer prices (Optional).
 void setPriceListIds(java.lang.Long[] aPriceListIds)
          Sets the ids of the input price lists to be used for retrieving the offers.
 void setPSExclusionList(java.lang.Integer[] aPSExclusionList)
          Sets the list of product sets excluded from the trading agreements (Optional).
 void setPSInclusionList(java.lang.Integer[] aPSInclusionList)
          Sets the list of product sets included in the trading agreements (Optional).
 void setQuantities(QuantityAmount[] aQuantityAmounts)
          Sets the quantity amount of the input catalog entry that is to be priced (Optional).
 void setStoreId(java.lang.Integer aStoreId)
          Sets the id of the input store to be used for calculating the price (Optional).
 
Methods inherited from interface com.ibm.commerce.command.BusinessPolicyCommand
getPolicyId, getRequestProperties, setPolicyId, setRequestProperties
 
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

NAME

public static final java.lang.String NAME
Method Detail

getItemOffers

public java.util.Hashtable[] getItemOffers()
Returns all the qualified offers retrieved for each of the input items.
Returns:
The qualified offers retrieved for each of the input items.

setCatEntryIds

public void setCatEntryIds(java.lang.Long[] aCatEntryIds)
Sets the ids of the input catalog entries for retrieving the offers.
Parameters:
aCatEntryIds - The reference number of one or more catalog entries for which the qualified offers are to be retrieved.

setCurrency

public void setCurrency(java.lang.String astrCurrency)
Sets the currency to be used for finding the price (Optional).
Parameters:
astrCurrency - The currency to look up 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).

setOfferIds

public void setOfferIds(java.lang.Long[] aOfferIds)
Sets the ids of the input offers to be used for retrieving the offer prices (Optional).
Parameters:
aOfferIds - The reference number of one or more offers that are to be used for determining the price. If no offer ids are supplied, then the "best" of all qualifying offers will be used. Otherwise, the "best" of the specified offers will be returned.

setPriceListIds

public void setPriceListIds(java.lang.Long[] aPriceListIds)
Sets the ids of the input price lists to be used for retrieving the offers.
Parameters:
aPriceListIds - The reference number of one or more price lists that are to be used for retrieving the offers.

setPSExclusionList

public void setPSExclusionList(java.lang.Integer[] aPSExclusionList)
Sets the list of product sets excluded from the trading agreements (Optional).
Parameters:
aPSExclusionList - The list of product sets excluded from the trading agreements.

setPSInclusionList

public void setPSInclusionList(java.lang.Integer[] aPSInclusionList)
Sets the list of product sets included in the trading agreements (Optional).
Parameters:
aPSExclusionList - The list of product sets included in the trading agreements.

setQuantities

public void setQuantities(QuantityAmount[] aQuantityAmounts)
Sets the quantity amount of the input catalog entry that is to be priced (Optional).
Parameters:
aQuantityAmount - The quantity amount of the catalog entry. 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.

setStoreId

public void setStoreId(java.lang.Integer aStoreId)
Sets the id of the input store to be used for calculating the price (Optional).
Parameters:
aStoreId - The reference number of a store to be used for calculating the price. If the store id is not specified then the store id of the command context will be used.