com.ibm.commerce.price.utils

Interface GetPriceCmdOutput

All Known Implementing Classes:

PriceOutputCaseGetPriceCmdOutput, SimpleGetPriceCmdOutput

public interface GetPriceCmdOutput

GetPriceCmdOutput represents the output values of GetContractUnitPriceCmd, GetProductContractUnitPriceCmd, and GetContractSpecialPriceCmd to make implementing those commands easier. There are several implementations of this interface:

• SimpleGetPriceCmdOutput
• PriceCaseGetPriceCmdOutput

Each method in this interface generally follows the contract of the corresponding method in the commands.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Method Summary

Modifier and Type	Method and Description
MixList<java.lang.Long>	getApplicableTradingIDs() Returns the identifiers of the trading agreements that were used to determine the prices for a catalog entry.
MixList<MonetaryAmount>	getApplicableUnitPrices() Returns the prices that were determined for each of the applied trading agreements for a catalog entry.
MonetaryAmount	getBasePrice() Returns the best price of the input catalog entry before any currency conversions.
MixList<CatEntryPrices>	getCatEntries() Returns the price related information for the input catalog entries.
com.ibm.commerce.order.objects.OfferAccessBean	getOffer() Returns the offer access bean that was used to determine the price.
java.lang.Long	getOfferID() Returns the identifier of the offer that was used to determine the price.
MonetaryAmount	getPrice() Returns the best price of the catalog entry in the requested currency.
java.lang.Long	getTcID() Returns the identifier of the term condition which was used to calculate the best price.
java.lang.Long	getTradingID() Returns the identifier of the trading agreement which was used to calculate the best price.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Method Detail

getApplicableTradingIDs

MixList<java.lang.Long> getApplicableTradingIDs()

Returns the identifiers of the trading agreements that were used to determine the prices for a catalog entry.

If the command is used in single mode, these identifiers will reflect the trading agreements that were specified for that catalog entry. If the command is used in batch mode, then these identifiers will reflect the trading agreements that were used for the first catalog entry in the input array.

Returns:

The identifiers of all the trading agreements that were used to obtain the prices for the specified catalog entry. This array may be null or empty if getPrice() returns null.

getApplicableUnitPrices

MixList<MonetaryAmount> getApplicableUnitPrices()

Returns the prices that were determined for each of the applied trading agreements for a catalog entry. Each element in the returned array corresponds to the element at the same index in the array returned by #getApplicableTradingIds().

If the command is used in single mode, these prices will reflect the prices that were found for the input catalog entry. If the command is used in batch mode, then these prices will reflect the prices that were used for the first catalog entry in the input array.

Returns:

The unit price amounts of the specified catalog entry in that each of them was determined individually for its corresponding trading agreement. This array may be null or empty if getPrice() returns null.

getBasePrice

MonetaryAmount getBasePrice()

Returns the best price of the input catalog entry before any currency conversions. This is only set when the requested currency is different from the base currency, in which case the base price must be converted to the requested price.

If the command is used in single mode, this price will be for the input catalog entry. If the command is used in batch mode, then this price will be for the first catalog entry in the input array.

Returns:

The best price found for the specified catalog entry. This value will be null if no currency conversion was performed to obtain the price in the requested currency.

getCatEntries

MixList<CatEntryPrices> getCatEntries()

Returns the price related information for the input catalog entries. Each element in the array will have various information set as a result of calling this command.

The following values reflect information about the best price for the catalog entry:

• CatEntryPrices.getTradingId()
• CatEntryPrices.getTcId()
• CatEntryPrices.getOfferId()
• CatEntryPrices.getOffer()
• CatEntryPrices.getBasePrice()
• CatEntryPrices.getUnitPrice()

The following values reflect information about all prices for the catalog entry:

• CatEntryPrices.getAllTradingIds()
• CatEntryPrices.getTradingTcIds()
• CatEntryPrices.getTradingOfferIds()
• CatEntryPrices.getTradingOffers()
• CatEntryPrices.getTradingBasePrices()
• CatEntryPrices.getTradingUnitPrices()

If this command is used in single mode, this array will contain one element corresponding to the input catalog entry. If this command is used in batch mode, then this array will contain the same catalog entry information, in the same order, as the input array.

In the latter case, the array itself is not guaranteed to be the same as the input array, and the elements are not guaranteed to be the same as those in the input array. However, for optimization purposes, they may be the same array and elements. In other words, users of this command should make no assumptions that the input array and elements are the same or different from the returned array.

Returns:

The price related information of the input catalog entries. This array will not be null or empty. See #setCatEntryPrices for information on the input array.

getOffer

com.ibm.commerce.order.objects.OfferAccessBean getOffer()

Returns the offer access bean that was used to determine the price.

If the command is used in single mode, this offer will be for the input catalog entry. If the command is used in batch mode, then this offer will be for the first catalog entry in the input array.

Returns:

The offer access bean associated with the offer that was used to determine the best price, or null if no offer was used or getPrice() returns null.

getOfferID

java.lang.Long getOfferID()

Returns the identifier of the offer that was used to determine the price.

If the command is used in single mode, this offer will be for the input catalog entry. If the command is used in batch mode, then this offer will be for the first catalog entry in the input array.

Returns:

The identifier of the offer that was used to determine the price, or null if no offer was used or getPrice() returns null.

getPrice

MonetaryAmount getPrice()

Returns the best price of the catalog entry in the requested currency.

If the command is used in single mode, this price will be for the input catalog entry. If the command is used in batch mode, then this price will be for the first catalog entry in the input array.

Returns:

The best price of the catalog entry in the requested currency. This value may be null if the error mode is set to true and no price was found.

getTcID

java.lang.Long getTcID()

Returns the identifier of the term condition which was used to calculate the best price.

If the command is used in single mode, this term condition will be for the input catalog entry. If the command is used in batch mode, then this term condition will be for the first catalog entry in the input array.

Returns:

The identifier of the term condition that was used to determine the best price. This value may be null if no term condition was used to determine the price or getPrice() returns null.

getTradingID

java.lang.Long getTradingID()

Returns the identifier of the trading agreement which was used to calculate the best price.

If the command is used in single mode, this trading agreement will be for the input catalog entry. If the command is used in batch mode, then this trading agreement will be for the first catalog entry in the input array.

Returns:

The identifier of the trading agreement that was used to determine the best price. This value may be null if no trading agreement was used to determine the price or getPrice() returns null.