PriceInputCaseGetPriceCmdInput

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

All Implemented Interfaces:

GetPriceCmdInput
```
public class PriceInputCaseGetPriceCmdInput
extends AbstractGetPriceCmdInput
```
PriceInputCaseGetPriceCmdInput represents a GetPriceCmdInput that is built up from many PriceInputCases. This is used to reconstruct a command input object after having split up the data into price input cases, as is done in CompositeGetContractUnitPriceCmdImpl.

Constructor Summary

Constructors
Constructor and Description
`PriceInputCaseGetPriceCmdInput(GetPriceCmdInput newOriginalUserInput, GetPriceCmdInput newOriginalDefaultInput)` Constructor for PriceInputCaseGetPriceCmdInput.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPriceCase(PriceInputCase priceInputCase)` Adds the given input case to this.
`void`	`checkInputCasesAdded()` Checks that at least one `PriceInputCase` has been added, and if not, throws an exception.
`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.

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

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

- Constructor Detail
  - PriceInputCaseGetPriceCmdInput
```
public PriceInputCaseGetPriceCmdInput(GetPriceCmdInput newOriginalUserInput,
                                      GetPriceCmdInput newOriginalDefaultInput)
```
    Constructor for PriceInputCaseGetPriceCmdInput.
    
    Parameters:
    
    newOriginalUserInput - The original input passed into the command before it was split into input cases. This input helps determine some information that cannot be reconstructed from the price cases alone (such as whether single or batch mode is being used). Cannot be null.
    
    newOriginalDefaultInput - The original input passed into the command before it was split into input cases. This input helps determine some information that cannot be reconstructed from the price cases alone (such as whether single or batch mode is being used). Cannot be null.
- Method Detail
  - addPriceCase
```
public void addPriceCase(PriceInputCase priceInputCase)
```
    Adds the given input case to this. The accumulated input cases will be converted to a more efficient form on the first call to an input method (any "get" method defined in GetPriceCmdInput).
    
    Parameters:
    
    priceInputCase - The input case to add. Cannot be null.
  - checkInputCasesAdded
```
public void checkInputCasesAdded()
                          throws java.lang.IllegalStateException
```
    Checks that at least one PriceInputCase has been added, and if not, throws an exception.
    
    Throws:
    
    java.lang.IllegalStateException - If no input cases have been added.
  - 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.
  - isBatchMode
```
public boolean isBatchMode()
```
    Description copied from interface: GetPriceCmdInput
    
    Returns whether the values in this indicate single mode or batch mode will be used. Batch mode is assumed if GetPriceCmdInput.getCatEntries() is not null or empty.
    
    Specified by:
    
    isBatchMode in interface GetPriceCmdInput
    
    Overrides:
    
    isBatchMode in class AbstractGetPriceCmdInput
    
    Returns:
    
    True if batch mode will be used, false otherwise.
  - 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.
  - isValid
```
public boolean isValid()
```
    Description copied from interface: GetPriceCmdInput
    
    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.
    
    Specified by:
    
    isValid in interface GetPriceCmdInput
    
    Overrides:
    
    isValid in class AbstractGetPriceCmdInput
    
    Returns:
    
    True if this input can be processed, false otherwise.

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

Methods inherited from class java.lang.Object

PriceInputCaseGetPriceCmdInput

addPriceCase

checkInputCasesAdded

getCatEntries

getCatEntryID

getCurrency

getCurrentTradingIDs

getCustomData

getEligibleTradingIDs

getMemberID

getOfferIDs

getOrderItem

getOrganizationID

getQuantity

getStoreID

getTradingIDs

isBatchMode

isThrowPriceExceptions

isValid