ComposeInventoryAvailabilityCmd

All Superinterfaces:

com.ibm.websphere.command.Command, java.io.Serializable

All Known Implementing Classes:

AbstractComposeInventoryAvailabilityCmdImpl, com.ibm.commerce.inventory.facade.server.commands.ComposeATPInventoryAvailabilityCmdImpl, ComposeATPInventoryAvailabilityForDKCmdImpl, ComposeDOMInventoryAvailabilityCmdImpl, ComposeExternalInventoryAvailabilityWithUOMCmdImpl
```
public interface ComposeInventoryAvailabilityCmd
extends com.ibm.websphere.command.Command
```
The command interface for the task commnad to compose InventoryAvailabilityType. Based on different inventory system, the default implementations are listed below: For DOM Inventory System, the default implementation is: com.ibm.commerce.inventory.facade.server.commands.ComposeDOMInventoryAvailabilityCmdImpl For ATP Inventory System, the default implementation is: com.ibm.commerce.inventory.facade.server.commands.ComposeATPInventoryAvailabilityCmdImpl For non-ATP Inventory System, the default implementation is: com.ibm.commerce.inventory.facade.server.commands.ComposeNonATPInventoryAvailabilityCmdImpl

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM Copyright notice field.
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

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
`BaseItemAccessBean`	`getBaseItem(java.lang.Long anCatalogEntryId)` Get the baseitem access bean of an catalog entry.
`CatalogEntryAccessBean`	`getCatalogEntry(java.lang.Long anCatalogEntryId)` Get the catalog entry access bean from the catalog entry Id.
`java.lang.Long[]`	`getCatalogEntryIds()` Get all the catalog entry Ids for the command.
`java.lang.String`	`getComponentId()` Get the component id of inventory component.
`java.util.List`	`getNouns()` Get the nouns of `InventoryAvailabilityType`.
`java.lang.String[]`	`getOnlineStoreIdentifiers()` Get the online store name identifiers.
`java.lang.Integer[]`	`getOnlineStoreIds()` Get the online store Ids.
`java.lang.String[]`	`getPartNumbers()` Get the part numbers of the catalog entries.
`java.lang.String[]`	`getPhysicalStoreIdentifiers()` Get the physical store external identifiers.
`java.lang.String[]`	`getPhysicalStoreIds()` Get the physical store Ids.
`SearchExpression`	`getSearchExpression()`
`void`	`setBaseItems(java.util.Map amapBaseItems)` Sets a map which contains the catalog entry id as the key and the catalog entry base item access bean as the value into the command.
`void`	`setCatalogEntryAccessBeans(java.util.Map amapCatalogEntries)` Sets a map which contains the catalog entry id as the key and catalog entry access bean as the value into the command.
`void`	`setCatalogEntryIds(java.lang.Long[] anCatalogEntryIds)` Set the catalog entry Ids.
`void`	`setComponentId(java.lang.String astrComponentId)` Set the inventory component id.
`void`	`setFulfillmentCenterIdList(java.lang.String astrFulfillmentCenterIdList)` Sets all the fulfillment center Ids lised in a string, seperated by comma, which is used to get the ATP inventories.
`void`	`setFulfillmentCenterIds(java.lang.Integer[] ainFulfillmentCenterIds)` Sets an array of the fulfillment center ids into the command.
`void`	`setNouns(java.util.List alistNouns)` Set the nouns of `InventoryAvailabilityType`
`void`	`setOnlineStoreFulfillmentCenterIds(java.util.Map amapOnlineStoreFulfillmentCenterIds)` Sets a map which contains the mapping from online store id to fulfillment center ids array.
`void`	`setOnlineStoreIdentifiers(java.lang.String[] astrOnlineStoreIdentifiers)` Set the online store name identifiers.
`void`	`setOnlineStoreIds(java.lang.Integer[] anOnlineStoreIds)` Set the online store Ids.
`void`	`setOnlineStores(java.util.Map amapOnlineStores)` Sets the map which contains the mapping from online store id to online store access bean.
`void`	`setPartNumbers(java.lang.String[] astrPartNumbers)` Set the catalog entry part numbers.
`void`	`setPhysicalStoreFulfillmentCenterIds(java.util.Map amapPhysicalStoreFulfillmentCenterIds)` Sets a map which contains the mapping from physical store id to fulfillment center ids array.
`void`	`setPhysicalStoreIdentifiers(java.lang.String[] astrPhysicalStoreIdentifiers)` Set the physical store external identifiers.
`void`	`setPhysicalStoreIds(java.lang.String[] astrPhysicalStoreIds)` Set the physical store Ids.
`void`	`setPhysicalStores(java.util.Map amapPhysicalStores)` Sets a map which contains the mapping from physical store id to `PhysicalStoreType` into the command.
`void`	`setSearchExpression(SearchExpression aSearchExpression)` Sets a `SearchExpression`.

Methods inherited from interface com.ibm.websphere.command.Command
execute, isReadyToCallExecute, reset

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    IBM Copyright notice field.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setNouns
```
void setNouns(java.util.List alistNouns)
```
    Set the nouns of InventoryAvailabilityType
    
    Parameters:
    
    alistNouns - A list of InventoryAvailabilityType to set.
  - getNouns
```
java.util.List getNouns()
```
    Get the nouns of InventoryAvailabilityType.
    
    Returns:
    
    A list of InventoryAvailabilityType.
  - setPhysicalStoreIdentifiers
```
void setPhysicalStoreIdentifiers(java.lang.String[] astrPhysicalStoreIdentifiers)
```
    Set the physical store external identifiers.
    
    Parameters:
    
    astrPhysicalStoreIdentifiers - A String array of the physical store external identifiers to be set.
  - setPhysicalStoreIds
```
void setPhysicalStoreIds(java.lang.String[] astrPhysicalStoreIds)
```
    Set the physical store Ids.
    
    Parameters:
    
    astrPhysicalStoreIds - an String array of the physical store Ids to be set.
  - setPartNumbers
```
void setPartNumbers(java.lang.String[] astrPartNumbers)
```
    Set the catalog entry part numbers.
    
    Parameters:
    
    astrPartNumbers -
  - setOnlineStoreIdentifiers
```
void setOnlineStoreIdentifiers(java.lang.String[] astrOnlineStoreIdentifiers)
```
    Set the online store name identifiers.
    
    Parameters:
    
    astrOnlineStoreIdentifiers - A String array of the online store name identifiers to be set.
  - setOnlineStoreIds
```
void setOnlineStoreIds(java.lang.Integer[] anOnlineStoreIds)
```
    Set the online store Ids.
    
    Parameters:
    
    anOnlineStoreIds - an integer array of the online store Ids to be set.
  - setCatalogEntryIds
```
void setCatalogEntryIds(java.lang.Long[] anCatalogEntryIds)
```
    Set the catalog entry Ids.
    
    Parameters:
    
    anCatalogEntryIds - an array of the catalog entry Ids to be set.
  - getPhysicalStoreIds
```
java.lang.String[] getPhysicalStoreIds()
```
    Get the physical store Ids.
    
    Returns:
    
    an String array of the physical store Ids.
  - getPhysicalStoreIdentifiers
```
java.lang.String[] getPhysicalStoreIdentifiers()
```
    Get the physical store external identifiers.
    
    Returns:
    
    A String array of the physical store external identifiers.
  - getPartNumbers
```
java.lang.String[] getPartNumbers()
```
    Get the part numbers of the catalog entries.
    
    Returns:
    
    a String array of the catalog entry part numbers.
  - getOnlineStoreIds
```
java.lang.Integer[] getOnlineStoreIds()
```
    Get the online store Ids.
    
    Returns:
    
    an Integer array of the online store Ids.
  - getOnlineStoreIdentifiers
```
java.lang.String[] getOnlineStoreIdentifiers()
```
    Get the online store name identifiers.
    
    Returns:
    
    A String array of the online store name identifiers.
  - getCatalogEntryIds
```
java.lang.Long[] getCatalogEntryIds()
```
    Get all the catalog entry Ids for the command.
    
    Returns:
    
    an array of the catalog entry Ids.
  - getBaseItem
```
BaseItemAccessBean getBaseItem(java.lang.Long anCatalogEntryId)
```
    Get the baseitem access bean of an catalog entry.
    
    Parameters:
    
    anCatalogEntryId - The catalog entry Id.
    
    Returns:
    
    The baseitem access bean.
  - getCatalogEntry
```
CatalogEntryAccessBean getCatalogEntry(java.lang.Long anCatalogEntryId)
```
    Get the catalog entry access bean from the catalog entry Id.
    
    Parameters:
    
    anCatalogEntryId - The catalog entry Id.
    
    Returns:
    
    The catalog entry access bean.
  - getComponentId
```
java.lang.String getComponentId()
```
    Get the component id of inventory component.
    
    Returns:
    
    the component id of inventory component.
  - setComponentId
```
void setComponentId(java.lang.String astrComponentId)
```
    Set the inventory component id.
    
    Parameters:
    
    astrComponentId - inventory component id.
  - setSearchExpression
```
void setSearchExpression(SearchExpression aSearchExpression)
```
    Sets a SearchExpression.
    
    Parameters:
    
    aSearchExpression - The SearchExpression.
  - getSearchExpression
```
SearchExpression getSearchExpression()
```
    Returns:
    
    Returns the SearchExpression
  - setCatalogEntryAccessBeans
```
void setCatalogEntryAccessBeans(java.util.Map amapCatalogEntries)
```
    Sets a map which contains the catalog entry id as the key and catalog entry access bean as the value into the command.
    
    Parameters:
    
    amapCatalogEntries - A map contains the catalog entry id as the key and catalog entry access bean as the value.
  - setBaseItems
```
void setBaseItems(java.util.Map amapBaseItems)
```
    Sets a map which contains the catalog entry id as the key and the catalog entry base item access bean as the value into the command.
    
    Parameters:
    
    amapBaseItems - A map contains the catalog entry id as the key and the catalog entry base item access bean as the value.
  - setPhysicalStores
```
void setPhysicalStores(java.util.Map amapPhysicalStores)
```
    Sets a map which contains the mapping from physical store id to PhysicalStoreType into the command.
    
    Parameters:
    
    amapPhysicalStores - A map which contains the mapping from physical store id to PhysicalStoreType.
  - setFulfillmentCenterIds
```
void setFulfillmentCenterIds(java.lang.Integer[] ainFulfillmentCenterIds)
```
    Sets an array of the fulfillment center ids into the command.
    
    Parameters:
    
    ainFulfillmentCenterIds - An integer array of fulfillment center ids.
  - setOnlineStoreFulfillmentCenterIds
```
void setOnlineStoreFulfillmentCenterIds(java.util.Map amapOnlineStoreFulfillmentCenterIds)
```
    Sets a map which contains the mapping from online store id to fulfillment center ids array.
    
    Parameters:
    
    amapOnlineStoreFulfillmentCenterIds - A map which contains the mapping from online store id to fulfillment center ids array
  - setPhysicalStoreFulfillmentCenterIds
```
void setPhysicalStoreFulfillmentCenterIds(java.util.Map amapPhysicalStoreFulfillmentCenterIds)
```
    Sets a map which contains the mapping from physical store id to fulfillment center ids array.
    
    Parameters:
    
    amapPhysicalStoreFulfillmentCenterIds - A map which contains the mapping from physical store id to fulfillment center ids array
  - setFulfillmentCenterIdList
```
void setFulfillmentCenterIdList(java.lang.String astrFulfillmentCenterIdList)
```
    Sets all the fulfillment center Ids lised in a string, seperated by comma, which is used to get the ATP inventories.
    
    Parameters:
    
    astrFulfillmentCenterIdList - A string of comma seperated fulfillment center ids.
  - setOnlineStores
```
void setOnlineStores(java.util.Map amapOnlineStores)
```
    Sets the map which contains the mapping from online store id to online store access bean.
    
    Parameters:
    
    amapOnlineStores - A map which contains the mapping from online store id to online store access bean.

Fields inherited from interface com.ibm.websphere.command.Command

Methods inherited from interface com.ibm.websphere.command.Command

COPYRIGHT

setNouns

getNouns

setPhysicalStoreIdentifiers

setPhysicalStoreIds

setPartNumbers

setOnlineStoreIdentifiers

setOnlineStoreIds

setCatalogEntryIds

getPhysicalStoreIds

getPhysicalStoreIdentifiers

getPartNumbers

getOnlineStoreIds

getOnlineStoreIdentifiers

getCatalogEntryIds

getBaseItem

getCatalogEntry

getComponentId

setComponentId

setSearchExpression

getSearchExpression

setCatalogEntryAccessBeans

setBaseItems

setPhysicalStores

setFulfillmentCenterIds

setOnlineStoreFulfillmentCenterIds

setPhysicalStoreFulfillmentCenterIds

setFulfillmentCenterIdList

setOnlineStores