com.ibm.commerce.price.commands
Interface SelectContractPricesCmd
- All Superinterfaces:
- ECCommand, TaskCommand
- All Known Implementing Classes:
- SelectContractPricesCmdImpl
- public interface SelectContractPricesCmd
- extends TaskCommand
Interface for the SelectContractPricesCmd
Task Command to
select the best offer among all the qualified offers for the input catalog
entry.
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 |
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.ECCommand |
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
COPYRIGHT
public static final java.lang.String COPYRIGHT
defaultCommandClassName
public static final java.lang.String defaultCommandClassName
NAME
public static final java.lang.String NAME
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.
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.