SimpleGetPriceCmdOutput

java.lang.Object
- com.ibm.commerce.price.utils.SimpleGetPriceCmdOutput

All Implemented Interfaces:

GetPriceCmdOutput
```
public class SimpleGetPriceCmdOutput
extends java.lang.Object
implements GetPriceCmdOutput
```
SimpleGetPriceCmdOutput is a GetPriceCmdOutput that has a "set" method for each "get" method.

Constructor Summary

Constructors
Constructor and Description

SimpleGetPriceCmdOutput()
Constructor for SimpleGetPriceCmdOutput.

Constructors
Constructor and Description
`SimpleGetPriceCmdOutput()` Constructor for SimpleGetPriceCmdOutput.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`void`	`setApplicableTradingIDs(MixList<java.lang.Long> newApplicableTradingIDs)` Sets all the trading agreements that had prices for the main catalog entry.
`void`	`setApplicableUnitPrices(MixList<MonetaryAmount> newApplicableUnitPrices)` Sets all the prices that were found for the main catalog entry.
`void`	`setBasePrice(MonetaryAmount newBasePrice)` Sets the best price for the main catalog entry before currency conversion.
`void`	`setCatEntries(MixList<CatEntryPrices> newCatEntries)` Sets the catalog entry information objects that correspond to the input catalog entry information objects, with the price information found for each one.
`void`	`setOffer(com.ibm.commerce.order.objects.OfferAccessBean newOffer)` Sets the offer access bean used to get the best price for the main catalog entry.
`void`	`setOfferID(java.lang.Long newOfferID)` Sets the offer identifier used to get the best price for the main catalog entry.
`void`	`setPrice(MonetaryAmount newPrice)` Sets the best price for the main catalog entry.
`void`	`setTcID(java.lang.Long newTCID)` Sets the term condition used to get the best price for the main catalog entry.
`void`	`setTradingID(java.lang.Long newTradingID)` Sets the trading agreement for the best price for the main catalog entry.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SimpleGetPriceCmdOutput
```
public SimpleGetPriceCmdOutput()
```
    Constructor for SimpleGetPriceCmdOutput.
- Method Detail
  - getApplicableTradingIDs
```
public MixList<java.lang.Long> getApplicableTradingIDs()
```
    Description copied from interface: GetPriceCmdOutput
    
    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.
    
    Specified by:
    
    getApplicableTradingIDs in interface GetPriceCmdOutput
    
    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 GetPriceCmdOutput.getPrice() returns null.
  - getApplicableUnitPrices
```
public MixList<MonetaryAmount> getApplicableUnitPrices()
```
    Description copied from interface: GetPriceCmdOutput
    
    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.
    
    Specified by:
    
    getApplicableUnitPrices in interface GetPriceCmdOutput
    
    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 GetPriceCmdOutput.getPrice() returns null.
  - getBasePrice
```
public MonetaryAmount getBasePrice()
```
    Description copied from interface: GetPriceCmdOutput
    
    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.
    
    Specified by:
    
    getBasePrice in interface GetPriceCmdOutput
    
    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
```
public MixList<CatEntryPrices> getCatEntries()
```
    Description copied from interface: GetPriceCmdOutput
    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:
    The following values reflect information about all prices for the catalog entry:
    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.
    Specified by:
    
    getCatEntries in interface GetPriceCmdOutput
    
    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
```
public com.ibm.commerce.order.objects.OfferAccessBean getOffer()
```
    Description copied from interface: GetPriceCmdOutput
    
    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.
    
    Specified by:
    
    getOffer in interface GetPriceCmdOutput
    
    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 GetPriceCmdOutput.getPrice() returns null.
  - getOfferID
```
public java.lang.Long getOfferID()
```
    Description copied from interface: GetPriceCmdOutput
    
    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.
    
    Specified by:
    
    getOfferID in interface GetPriceCmdOutput
    
    Returns:
    
    The identifier of the offer that was used to determine the price, or null if no offer was used or GetPriceCmdOutput.getPrice() returns null.
  - getPrice
```
public MonetaryAmount getPrice()
```
    Description copied from interface: GetPriceCmdOutput
    
    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.
    
    Specified by:
    
    getPrice in interface GetPriceCmdOutput
    
    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
```
public java.lang.Long getTcID()
```
    Description copied from interface: GetPriceCmdOutput
    
    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.
    
    Specified by:
    
    getTcID in interface GetPriceCmdOutput
    
    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 GetPriceCmdOutput.getPrice() returns null.
  - getTradingID
```
public java.lang.Long getTradingID()
```
    Description copied from interface: GetPriceCmdOutput
    
    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.
    
    Specified by:
    
    getTradingID in interface GetPriceCmdOutput
    
    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 GetPriceCmdOutput.getPrice() returns null.
  - setApplicableTradingIDs
```
public void setApplicableTradingIDs(MixList<java.lang.Long> newApplicableTradingIDs)
```
    Sets all the trading agreements that had prices for the main catalog entry.
    
    Parameters:
    
    newApplicableTradingIDs - The list of trading agreement identifiers that had prices for the main catalog entry. May be null or empty.
    
    See Also:
    
    getApplicableTradingIDs()
  - setApplicableUnitPrices
```
public void setApplicableUnitPrices(MixList<MonetaryAmount> newApplicableUnitPrices)
```
    Sets all the prices that were found for the main catalog entry.
    
    Parameters:
    
    newApplicableUnitPrices - The list of prices found for the main catalog entry. May be null or empty.
    
    See Also:
    
    getApplicableUnitPrices()
  - setBasePrice
```
public void setBasePrice(MonetaryAmount newBasePrice)
```
    Sets the best price for the main catalog entry before currency conversion.
    
    Parameters:
    
    newBasePrice - The best base price for the main catalog entry, before any currency conversion. May be null.
    
    See Also:
    
    getBasePrice()
  - setCatEntries
```
public void setCatEntries(MixList<CatEntryPrices> newCatEntries)
```
    Sets the catalog entry information objects that correspond to the input catalog entry information objects, with the price information found for each one.
    
    Parameters:
    
    newCatEntries - The catalog information objects that were output from the command. May be null or empty.
    
    See Also:
    
    getCatEntries()
  - setOffer
```
public void setOffer(com.ibm.commerce.order.objects.OfferAccessBean newOffer)
```
    Sets the offer access bean used to get the best price for the main catalog entry.
    
    Parameters:
    
    newOffer - The offer access bean for the best price for the main catalog entry. May be null.
    
    See Also:
    
    getOffer()
  - setOfferID
```
public void setOfferID(java.lang.Long newOfferID)
```
    Sets the offer identifier used to get the best price for the main catalog entry.
    
    Parameters:
    
    newOfferID - The offer identifier for the best price for the main catalog entry. May be null.
    
    See Also:
    
    getOffer()
  - setPrice
```
public void setPrice(MonetaryAmount newPrice)
```
    Sets the best price for the main catalog entry.
    
    Parameters:
    
    newPrice - The best price for the main catalog entry. May be null.
    
    See Also:
    
    getPrice()
  - setTcID
```
public void setTcID(java.lang.Long newTCID)
```
    Sets the term condition used to get the best price for the main catalog entry.
    
    Parameters:
    
    newTCID - The term condition identifier for the best price for the main catalog entry. May be null.
    
    See Also:
    
    getTcID()
  - setTradingID
```
public void setTradingID(java.lang.Long newTradingID)
```
    Sets the trading agreement for the best price for the main catalog entry.
    
    Parameters:
    
    newTradingID - The trading agreement identifier for the best price for the main catalog entry. May be null.
    
    See Also:
    
    getTradingID()

Methods inherited from class java.lang.Object

SimpleGetPriceCmdOutput

getApplicableTradingIDs

getApplicableUnitPrices

getBasePrice

getCatEntries

getOffer

getOfferID

getPrice

getTcID

getTradingID

setApplicableTradingIDs

setApplicableUnitPrices

setBasePrice

setCatEntries

setOffer

setOfferID

setPrice

setTcID

setTradingID