com.ibm.commerce.price.commands

Interface RetrievePricesCmd

All Superinterfaces:

com.ibm.commerce.command.BusinessPolicyCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.TaskCommand

All Known Implementing Classes:

MarketplaceRetrievePricesCmdImpl, RetrievePricesCmdImpl

public interface RetrievePricesCmd
extends com.ibm.commerce.command.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

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	defaultCommandClassName The default name of this command.
static java.lang.String	NAME The name of this command.

Method Summary

Modifier and Type	Method and Description
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 class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.command.BusinessPolicyCommand

getPolicyId, getRequestProperties, setPolicyId, setRequestProperties

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

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default name of this command.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of this command.

See Also:

Constant Field Values

Method Detail

getItemOffers

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

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

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

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

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 num or mores price lists that are to be used for retrieving the offers.

setPSExclusionList

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

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

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

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.