SimpleGetPriceCmdInput

java.lang.Object
- com.ibm.commerce.price.utils.AbstractGetPriceCmdInput
- - com.ibm.commerce.price.utils.SimpleGetPriceCmdInput

All Implemented Interfaces:

GetPriceCmdInput
```
public class SimpleGetPriceCmdInput
extends AbstractGetPriceCmdInput
```
SimpleGetPriceCmdInput is a GetPriceCmdInput that has a "set" method for each "get" method.

Constructor Summary

Constructors
Constructor and Description

SimpleGetPriceCmdInput()
Constructor for SimpleGetPriceCmdInput.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MixList<CatEntryPrices>`	`getCatEntries()` Returns the catalog entry information which is used in batch mode.
`java.lang.Long`	`getCatEntryID()` Returns the catalog entry for single mode calculations.
`java.lang.String`	`getCurrency()` Returns the currency to be used.
`MixList<java.lang.Long>`	`getCurrentTradingIDs()` Returns the trading agreements that are currently assigned to the user.
`java.util.Map`	`getCustomData()` Returns the custom data associated with the main catalog entry.
`MixList<java.lang.Long>`	`getEligibleTradingIDs()` Returns the trading agreements that the user is entitled to use.
`java.lang.Long`	`getMemberID()` Returns the member that will be used to determine entitlement for the trading agreements.
`java.lang.Long[]`	`getOfferIDs()` Returns the offer identifiers that will take precedence among the valid offers.
`com.ibm.commerce.order.objects.OrderItemAccessBean`	`getOrderItem()` Returns the order item that is given by the order component.
`java.lang.Long`	`getOrganizationID()` Returns the organization under which the member acts for determining entitlement.
`QuantityAmount`	`getQuantity()` Returns the quantity to be used in single mode.
`java.lang.Integer`	`getStoreID()` Returns the store to be used to determine prices.
`MixList<java.lang.Long>`	`getTradingIDs()` Returns the trading agreements to use when determining prices.
`java.lang.Boolean`	`isThrowPriceExceptions()` Returns whether the command will throw an exception if a price could not be found.
`void`	`setCatEntries(MixList<CatEntryPrices> newCatEntries)` Sets the catalog entry information objects.
`void`	`setCatEntryID(java.lang.Long newCatEntryID)` Sets the catalog entry identifier.
`void`	`setCurrency(java.lang.String newCurrency)` Sets the currency.
`void`	`setCustomData(java.util.Map newCustomData)` Sets the custom data for the command.
`void`	`setMemberID(java.lang.Long newMemberID)` Sets the member identifier.
`void`	`setOfferIDs(java.lang.Long[] newOfferIDs)` Sets the offer identifiers.
`void`	`setOrderItem(com.ibm.commerce.order.objects.OrderItemAccessBean newOrderItem)` Sets the order item for this command.
`void`	`setOrganizationID(java.lang.Long newOrganizationID)` Sets the organization identifier.
`void`	`setQuantity(QuantityAmount newQuantity)` Sets the quantity.
`void`	`setStoreID(java.lang.Integer newStoreID)` Sets the store identifier.
`void`	`setThrowPriceExceptions(java.lang.Boolean newThrowPriceExceptions)` Sets whether the command throws exceptions when no price is found.
`void`	`setTradingIDs(MixList<java.lang.Long> newTradingIDs)` Sets the trading agreement identifiers.

Methods inherited from class com.ibm.commerce.price.utils.AbstractGetPriceCmdInput
isBatchMode, isValid, setToCommand, setToCommand, setToCommand, toString

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

- Constructor Detail
  - SimpleGetPriceCmdInput
```
public SimpleGetPriceCmdInput()
```
    Constructor for SimpleGetPriceCmdInput.
- Method Detail
  - getCatEntries
```
public MixList<CatEntryPrices> getCatEntries()
```
    Description copied from interface: GetPriceCmdInput
    Returns the catalog entry information which is used in batch mode. This corresponds to:
    - GetContractUnitPriceCmd.setCatEntryPrices(CatEntryPrices[])
    - GetContractSpecialPriceCmd.setCatEntryPrices(CatEntryPrices[])
    Returns:
    
    The catalog entry information to be used in batch mode. May be null if single mode is used.
  - getCatEntryID
```
public java.lang.Long getCatEntryID()
```
    Description copied from interface: GetPriceCmdInput
    Returns the catalog entry for single mode calculations. This corresponds to:
    Returns:
    
    The catalog entry identifier for single mode calculations. May be null if batch mode is used.
  - getCurrency
```
public java.lang.String getCurrency()
```
    Description copied from interface: GetPriceCmdInput
    Returns the currency to be used. This corresponds to:
    Returns:
    
    The currency to be used. This value will not be empty, but may be null to indicate that a default should be used.
  - getCurrentTradingIDs
```
public MixList<java.lang.Long> getCurrentTradingIDs()
```
    Description copied from interface: GetPriceCmdInput
    
    Returns the trading agreements that are currently assigned to the user. This will be different from those in the command context if the member from the context is not used.
    This method does not have a corresponding method in any of the price commands.
    
    Returns:
    
    The identifiers of trading agreements to be used when calculating prices. May be null to indicate that all entitled trading agreements should be used. May also be null to indicate that a default value should be used.
  - getCustomData
```
public java.util.Map getCustomData()
```
    Description copied from interface: GetPriceCmdInput
    Returns the custom data associated with the main catalog entry. This corresponds to:
    - GetCustomContractUnitPriceCmd#setCustomData(Map)
    Returns:
    
    The custom data. May be null or empty if there is no custom data. May also be null to indicate that a default value should be used.
  - getEligibleTradingIDs
```
public MixList<java.lang.Long> getEligibleTradingIDs()
```
    Description copied from interface: GetPriceCmdInput
    
    Returns the trading agreements that the user is entitled to use. This will be different from those in the command context if the member from the context is not used.
    This method does not have a corresponding method in any of the price commands.
    
    Returns:
    
    The identifiers of trading agreements to be used when calculating prices. May be null to indicate that all entitled trading agreements should be used. May also be null to indicate that a default value should be used.
  - getMemberID
```
public java.lang.Long getMemberID()
```
    Description copied from interface: GetPriceCmdInput
    Returns the member that will be used to determine entitlement for the trading agreements. This corresponds to:
    - GetContractUnitPriceCmd.setMemberId(Long)
    Returns:
    
    The identifier of the member that is used to determine entitlement. May be null to indicate that a default value should be used.
  - getOfferIDs
```
public java.lang.Long[] getOfferIDs()
```
    Description copied from interface: GetPriceCmdInput
    Returns the offer identifiers that will take precedence among the valid offers. This corresponds to:
    Returns:
    
    The offers to take precedence. May be null or empty if no offers are specified. May also be null to indicate that a default value should be used.
  - getOrderItem
```
public com.ibm.commerce.order.objects.OrderItemAccessBean getOrderItem()
```
    Description copied from interface: GetPriceCmdInput
    Returns the order item that is given by the order component. This corresponds to:
    - GetContractSpecialPriceCmd.setOrderItemAccessBean(OrderItemAccessBean)
    Returns:
    
    The order item that is given by the order component. May be null if the order component did not call the command, the order component called the command but did not set the order item, or to indicate that a default value should be used.
  - getOrganizationID
```
public java.lang.Long getOrganizationID()
```
    Description copied from interface: GetPriceCmdInput
    Returns the organization under which the member acts for determining entitlement. This corresponds to:
    - GetContractUnitPriceCmd.setOrganizationId(Long)
    Returns:
    
    The identifier of the organization under which the member acts for determining entitlement. May be null to indicate that a default value should be used.
  - getQuantity
```
public QuantityAmount getQuantity()
```
    Description copied from interface: GetPriceCmdInput
    Returns the quantity to be used in single mode. This corresponds to:
    Returns:
    
    The quantity to be used in single mode. May be null if batch mode is used, or to indicate that a default value should be used.
  - getStoreID
```
public java.lang.Integer getStoreID()
```
    Description copied from interface: GetPriceCmdInput
    Returns the store to be used to determine prices. This corresponds to:
    Returns:
    
    The identifier of the store which is used to determine prices. May be null to indicate that a default value should be used.
  - getTradingIDs
```
public MixList<java.lang.Long> getTradingIDs()
```
    Description copied from interface: GetPriceCmdInput
    Returns the trading agreements to use when determining prices. This corresponds to:
    Returns:
    
    The identifiers of trading agreements to be used when calculating prices. May be null to indicate that all entitled trading agreements should be used. May also be null to indicate that a default value should be used.
  - isThrowPriceExceptions
```
public java.lang.Boolean isThrowPriceExceptions()
```
    Description copied from interface: GetPriceCmdInput
    Returns whether the command will throw an exception if a price could not be found. This corresponds to:
    Returns:
    
    True if an exception will be thrown, false if an exception will not be thrown. May be null to indicate that a default value should be used.
  - setCatEntries
```
public void setCatEntries(MixList<CatEntryPrices> newCatEntries)
```
    Sets the catalog entry information objects.
    
    Parameters:
    
    newCatEntries - The catalog entry information objects. May be null or empty.
    
    See Also:
    
    getCatEntries()
  - setCatEntryID
```
public void setCatEntryID(java.lang.Long newCatEntryID)
```
    Sets the catalog entry identifier.
    
    Parameters:
    
    newCatEntryID - The catalog entry ID. May be null.
    
    See Also:
    
    getCatEntryID()
  - setCurrency
```
public void setCurrency(java.lang.String newCurrency)
```
    Sets the currency.
    
    Parameters:
    
    newCurrency - The currency. May be null, but not empty.
    
    See Also:
    
    getCurrency()
  - setCustomData
```
public void setCustomData(java.util.Map newCustomData)
```
    Sets the custom data for the command.
    
    Parameters:
    
    newCustomData - The custom data. Any key and value may be used. May be null.
    
    See Also:
    
    getCustomData()
  - setMemberID
```
public void setMemberID(java.lang.Long newMemberID)
```
    Sets the member identifier.
    
    Parameters:
    
    newMemberID - The member identifier. May be null.
    
    See Also:
    
    getMemberID()
  - setOfferIDs
```
public void setOfferIDs(java.lang.Long[] newOfferIDs)
```
    Sets the offer identifiers.
    
    Parameters:
    
    newOfferIDs - The offer identifiers. May be null or empty.
    
    See Also:
    
    getOfferIDs()
  - setOrderItem
```
public void setOrderItem(com.ibm.commerce.order.objects.OrderItemAccessBean newOrderItem)
```
    Sets the order item for this command.
    
    Parameters:
    
    newOrderItem - The order item. May be null.
    
    See Also:
    
    getOrderItem()
  - setOrganizationID
```
public void setOrganizationID(java.lang.Long newOrganizationID)
```
    Sets the organization identifier.
    
    Parameters:
    
    newOrganizationID - The organization identifier. May be null.
    
    See Also:
    
    getOrganizationID()
  - setQuantity
```
public void setQuantity(QuantityAmount newQuantity)
```
    Sets the quantity.
    
    Parameters:
    
    newQuantity - The quantity. May be null.
    
    See Also:
    
    getQuantity()
  - setStoreID
```
public void setStoreID(java.lang.Integer newStoreID)
```
    Sets the store identifier.
    
    Parameters:
    
    newStoreID - The store identifier. May be null.
    
    See Also:
    
    getStoreID()
  - setThrowPriceExceptions
```
public void setThrowPriceExceptions(java.lang.Boolean newThrowPriceExceptions)
```
    Sets whether the command throws exceptions when no price is found.
    
    Parameters:
    
    newThrowPriceExceptions - True indicates the command will throw exceptions, false indicates the command will not throw exceptions, and null indicates the value is not set (likely deferred to a default value).
    
    See Also:
    
    isThrowPriceExceptions()
  - setTradingIDs
```
public void setTradingIDs(MixList<java.lang.Long> newTradingIDs)
```
    Sets the trading agreement identifiers.
    
    Parameters:
    
    newTradingIDs - The trading agreement identifiers. May be null or empty.
    
    See Also:
    
    getTradingIDs()

Methods inherited from class com.ibm.commerce.price.utils.AbstractGetPriceCmdInput

Methods inherited from class java.lang.Object

SimpleGetPriceCmdInput

getCatEntries

getCatEntryID

getCurrency

getCurrentTradingIDs

getCustomData

getEligibleTradingIDs

getMemberID

getOfferIDs

getOrderItem

getOrganizationID

getQuantity

getStoreID

getTradingIDs

isThrowPriceExceptions

setCatEntries

setCatEntryID

setCurrency

setCustomData

setMemberID

setOfferIDs

setOrderItem

setOrganizationID

setQuantity

setStoreID

setThrowPriceExceptions

setTradingIDs