com.ibm.commerce.price.commands
Interface CalculateContractPricesCmd

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

public interface CalculateContractPricesCmd
extends TaskCommand

Interface for the CalculateContractPricesCmd 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
 ItemPriceInfo[] getItemPriceInfo()
          Returns the internal item info structure.
 void setCurrency(java.lang.String astrCurrency)
          Sets the currency to be used for finding the price (Optional).
 void setErrorMode(boolean aErrorMode)
          Sets the flag to indicate if exception will be thrown when the price cannot be found for the input catentry (Optional).
 void setItemPriceInfo(ItemPriceInfo[] aItemPriceInfo)
          Sets the item info structure for internal use on calculating the prices.
 void setMasterCatalogPriceListIds(java.lang.Long[] aPriceListIds)
          Sets the ids the price list associated with the Master Catalog (Optional).
 void setPriceListIds(java.lang.Long[] aPriceListIds)
          Sets the ids of the input price lists to be used for retrieving the offers (Optional).
 void setStoreId(java.lang.Integer aStoreId)
          Sets the id of the input store to be used for calculating the price (Optional).
 void setTradingABs(TradingAgreementAccessBean[] aTradingABs)
          Sets the input trading agreement access beans for determining the contract prices.
 void setUseGlobalPriceList(boolean aUseGlobalPriceList)
          Sets the flag to indicate if the list of input price lists can be used globally for retrieving the offers for all of the input catentries (Optional).
 
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

getItemPriceInfo

public ItemPriceInfo[] getItemPriceInfo()
Returns the internal item info structure.
Returns:
The item info structure for storing information such as the trading agreements, price lists that will be used for calculating the prices of the items.

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

setErrorMode

public void setErrorMode(boolean aErrorMode)
Sets the flag to indicate if exception will be thrown when the price cannot be found for the input catentry (Optional).
Parameters:
aErrorMode - The indicator to decide if an exception will be thrown when the price cannot be found. A true value (default) means throw exception. A false value means do not throw exception and returns a null value price

setItemPriceInfo

public void setItemPriceInfo(ItemPriceInfo[] aItemPriceInfo)
Sets the item info structure for internal use on calculating the prices.
Parameters:
aItemPriceInfo - the item info structure for storing information such as the trading agreements, price lists that will be used for calculating the prices of the items.

setMasterCatalogPriceListIds

public void setMasterCatalogPriceListIds(java.lang.Long[] aPriceListIds)
Sets the ids the price list associated with the Master Catalog (Optional).
Parameters:
aPriceListIds - the price list ids for the Master Catalog.

setPriceListIds

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

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.

setTradingABs

public void setTradingABs(TradingAgreementAccessBean[] aTradingABs)
Sets the input trading agreement access beans for determining the contract prices.
Parameters:
aTradingABs - The access beans of a list of trading agreements to be used to determine the price lists and to obtain the Ts&Cs information such as the price adjustment that is to be applied to the offers retrieved from the price lists.

setUseGlobalPriceList

public void setUseGlobalPriceList(boolean aUseGlobalPriceList)
Sets the flag to indicate if the list of input price lists can be used globally for retrieving the offers for all of the input catentries (Optional).
Parameters:
aUseGlobalPriceList - The indicator to decide if the price lists can be used globally. A true value (default) means apply the price lists globally. A false value means individual set of price lists should be obtained for each catentry (Future Support).