GetPriceCmdInput

All Known Implementing Classes:

AbstractGetPriceCmdInput, PriceInputCaseGetPriceCmdInput, PrioritizedGetPriceCmdInput, SimpleGetPriceCmdInput
```
public interface GetPriceCmdInput
```
GetPriceCmdInput represents the input values of GetContractUnitPriceCmd, GetProductContractUnitPriceCmd, GetContractSpecialPriceCmd, and GetCustomContractUnitPriceCmd to make implementing those commands easier. There are several implementations of this interface:
For all "get" methods that have a corresponding "set" method in these commands, null may be returned to indicate that the value should be obtained in another way. More specifically, null indicates that a default value may need to be used. Note that null may also be a legitimate value for some of these methods.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field.

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

Method Summary

All Methods Instance Methods Abstract 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.
`boolean`	`isBatchMode()` Returns whether the values in this indicate single mode or batch mode will be used.
`java.lang.Boolean`	`isThrowPriceExceptions()` Returns whether the command will throw an exception if a price could not be found.
`boolean`	`isValid()` Returns whether if this input can be processed by a command.
`void`	`setToCommand(GetContractSpecialPriceCmd cmd)` Sets all applicable values from this to the given command.
`void`	`setToCommand(GetContractUnitPriceCmd cmd)` Sets all applicable values from this to the given command.
`void`	`setToCommand(GetProductContractUnitPriceCmd cmd)` Sets all applicable values from this to the given command.

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getCatEntries
```
MixList<CatEntryPrices> getCatEntries()
```
    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
```
java.lang.Long getCatEntryID()
```
    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
```
java.lang.String getCurrency()
```
    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
```
MixList<java.lang.Long> getCurrentTradingIDs()
```
    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
```
java.util.Map getCustomData()
```
    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
```
MixList<java.lang.Long> getEligibleTradingIDs()
```
    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
```
java.lang.Long getMemberID()
```
    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
```
java.lang.Long[] getOfferIDs()
```
    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
```
com.ibm.commerce.order.objects.OrderItemAccessBean getOrderItem()
```
    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
```
java.lang.Long getOrganizationID()
```
    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
```
QuantityAmount getQuantity()
```
    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
```
java.lang.Integer getStoreID()
```
    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
```
MixList<java.lang.Long> getTradingIDs()
```
    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.
  - isBatchMode
```
boolean isBatchMode()
```
    Returns whether the values in this indicate single mode or batch mode will be used. Batch mode is assumed if getCatEntries() is not null or empty.
    
    Returns:
    
    True if batch mode will be used, false otherwise.
  - isThrowPriceExceptions
```
java.lang.Boolean isThrowPriceExceptions()
```
    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.
  - isValid
```
boolean isValid()
```
    Returns whether if this input can be processed by a command. At a minimum, this will check if any catalog entries are defined either in single mode or batch mode.
    
    Returns:
    
    True if this input can be processed, false otherwise.
  - setToCommand
```
void setToCommand(GetContractSpecialPriceCmd cmd)
```
    Sets all applicable values from this to the given command.
    
    Parameters:
    
    cmd - The command to set values on. Cannot be null.
  - setToCommand
```
void setToCommand(GetContractUnitPriceCmd cmd)
```
    Sets all applicable values from this to the given command.
    
    Parameters:
    
    cmd - The command to set values on. Cannot be null.
  - setToCommand
```
void setToCommand(GetProductContractUnitPriceCmd cmd)
```
    Sets all applicable values from this to the given command.
    
    Parameters:
    
    cmd - The command to set values on. Cannot be null.

COPYRIGHT

getCatEntries

getCatEntryID

getCurrency

getCurrentTradingIDs

getCustomData

getEligibleTradingIDs

getMemberID

getOfferIDs

getOrderItem

getOrganizationID

getQuantity

getStoreID

getTradingIDs

isBatchMode

isThrowPriceExceptions

isValid

setToCommand

setToCommand

setToCommand