Field Detail

• CLASSNAME

  public static final java.lang.String CLASSNAME
  

  Class name field.

  See Also:

  Constant Field Values

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM Copyright notice field.

  See Also:

  Constant Field Values

Constructor Detail

• ShowInventoryBalance

  public ShowInventoryBalance()
  

Method Detail

• init

  public void init(CommandContext aCmdCtxt,
          TypedProperty aRequestProperties,
          TypedProperty aResponseProperties,
          org.w3c.dom.Document aRequestBOD,
          org.w3c.dom.Document aResponseBOD)
  

  This method initializes the necessary parameters before starting to build the response Business Object Document.

  This method first calls the init method from the parent class.

  It will then call the initializeSearchTypeMapping to initialize the mappings between the search type obtained from the SelectExpression element in the request Business Object Document to the actual value set to the search bean.

  Specified by:

  init in interface ITelesalesResponseBuilder

  Overrides:

  init in class TelesalesResponseBuilderImpl

  Parameters:

  aCmdCtxt - The commandContext sent by the client.

  aRequestProperties - The request properties sent by the client.

  aResponseProperties - The response properties sent by the client.

  aRequestBOD - The request Business Object Document sent by the client.

  aResponseBOD - The respond Business Object document needs to be built.

  See Also:

  TelesalesResponseBuilderImpl.initializeSearchTypeMapping()

• buildDataArea

  protected void buildDataArea()
                        throws ECException
  

  This method builds the Data Area subsection of the reply BOD.

  This method will do the following:

  • Call the method getSearchCriteria to get the search criteria from the request Business Object Document.
  • Call the method executeGetInventoryBalance to obtain the inventory balance search result.
  • For each inventory found in the search result, it will then call the createInventoryBalanceElement method to create the InventoryBalance element.

  
    <wc:DataArea>
       <oa:Show confirm="Always"/>
       <wc:InventoryBalance> <-- createInventoryBalanceElement() -->
          
       </wc:InventoryBalance>
    </wc:DataArea>
  
   
  

  Specified by:

  buildDataArea in class TelesalesResponseBuilderImpl

  Throws:

  ECException

  See Also:

  createInventoryBalanceElement(InventorySearchResultBean)

• createSiteElement

  protected org.w3c.dom.Element createSiteElement(com.ibm.commerce.telesales.messaging.beans.InventorySearchResultBean inventorySearchResultBean,
                                      org.w3c.dom.Element aParentElement)
                                           throws ECException
  

  This method builds the SiteId element (Fulfillment Center information).

          <oa:Site>
                  <oa:Name lang="en">Site Name</oa:Name> 
                  <oa:Id>Site Id</oa:Id> 
          </oa:Site>
   
  

  Parameters:

  InventorySearchResultBean - The bean which contains the inventory information.

  aParentElement - The parent element which the SiteId element will build on.

  Returns:

  The SiteId element created.

  Throws:

  ECException

• createSiteElement

  protected org.w3c.dom.Element createSiteElement(com.ibm.commerce.inventory.beans.InventoryFFCSearchResultDataBean abnInventoryFFCSearchResultDataBean,
                                      org.w3c.dom.Element aParentElement)
                                           throws ECException
  

  Deprecated. use createSiteElement(InventorySearchResultBean, Element)
  This method builds the SiteId element (Fulfillment Center information).

          <oa:Site>
                  <oa:Name lang="en">Site Name</oa:Name> 
                  <oa:Id>Site Id</oa:Id> 
          </oa:Site>
   
  

  Parameters:

  abnInventoryFFCSearchResultDataBean - The bean which contains the inventory information.

  aParentElement - The parent element which the SiteId element will build on.

  Returns:

  The SiteId element created.

  Throws:

  ECException

• createItemElement

  protected org.w3c.dom.Element createItemElement(com.ibm.commerce.inventory.beans.InventoryFFCSearchResultDataBean abnInventoryFFCSearchResultDataBean,
                                      AttributeValueDataBean[] abnAttributeValue,
                                      org.w3c.dom.Element aParentElement)
                                           throws ECException
  

  Deprecated. use createItemElement(InventorySearchResultBean, AttributeValueDataBean[], Element)
  This method builds the Item element.

   <oa:Item>
                  <oa:ItemId>
                          <oa:Id>Item Id</oa:Id> 
                  </oa:ItemId>
                  <oa:Property>
                          <oa:NameValue name="Property Name">Property Value</oa:NameValue> 
                  </oa:Property>
                  .
                  .
          </oa:Item>
  
   
  

  Parameters:

  abnInventoryFFCSearchResultDataBean - The bean which contains the inventory information.

  abnAttributeValue - The attribute bean which contains the attributes of the inventory item

  aParentElement - The parent element which the Item element will build on.

  Returns:

  The Item element created.

  Throws:

  ECException

• createItemElement

  protected org.w3c.dom.Element createItemElement(com.ibm.commerce.telesales.messaging.beans.InventorySearchResultBean abnSearchResultDataBean,
                                      AttributeValueDataBean[] abnAttributeValue,
                                      org.w3c.dom.Element aParentElement)
                                           throws ECException
  

  This method builds the Item element.

   <oa:Item>
                  <oa:ItemId>
                          <oa:Id>Item Id</oa:Id> 
                  </oa:ItemId>
                  <oa:Property>
                          <oa:NameValue name="Property Name">Property Value</oa:NameValue> 
                  </oa:Property>
                  .
                  .
          </oa:Item>
  
   
  

  Parameters:

  InventorySearchResultBean - The bean which contains the inventory information.

  abnAttributeValue - The attribute bean which contains the attributes of the inventory item

  aParentElement - The parent element which the Item element will build on.

  Returns:

  The Item element created.

  Throws:

  ECException

• createInventoryBalanceElement

  protected org.w3c.dom.Element createInventoryBalanceElement(InventoryBalanceSearchResultBean abnInventoryItemSearchResult)
                                                       throws ECException
  

  Deprecated. use createInventoryBalanceElement(InventorySearchResultBean)
  This method builds the InventoryBalance element.

   <wc:InventoryBalance>
                  <!-- createItemElement() -->
                  <oa:Description lang="language code">Inventory Balance Description</oa:Description> 
                  <!-- createSiteElement() -->
                  <oa:AvailableQuantity uom="each">quantiry</oa:AvailableQuantity> 
                  <wc:ExpectedQuantity uom="each">quantiry</wc:ExpectedQuantity> 
                  <UserData>    <!-- createUserDataElement(SearchResultBean, Element) -->
                          <UserDataField name="Name">"Value"</UserDataField>
                  <UserData/>
   </wc:InventoryBalance>
   
  

  Parameters:

  abnInventoryItemSearchResult - The bean which contains the Inventory Balance information.

  Returns:

  The InventoryBalance element created.

  Throws:

  ECException

  See Also:

  createItemElement(InventoryFFCSearchResultDataBean, AttributeValueDataBean[], Element), createSiteElement(InventoryFFCSearchResultDataBean, Element), TelesalesResponseBuilderImpl.createUserDataElement(SearchResultBean, Element)

• createInventoryBalanceElement

  protected org.w3c.dom.Element createInventoryBalanceElement(com.ibm.commerce.telesales.messaging.beans.InventorySearchResultBean inventorySearchResultBean)
                                                       throws ECException,
                                                              java.rmi.RemoteException,
                                                              javax.ejb.CreateException,
                                                              javax.ejb.FinderException,
                                                              javax.naming.NamingException
  

  This method builds the InventoryBalance element.

   <wc:InventoryBalance>
                  <!-- createItemElement() -->
                  <oa:Description lang="language code">Inventory Balance Description</oa:Description> 
                  <!-- createSiteElement() -->
                  <oa:AvailableQuantity uom="each">quantiry</oa:AvailableQuantity> 
                  <wc:ExpectedQuantity uom="each">quantiry</wc:ExpectedQuantity> 
                  <UserData>    <!-- createUserDataElement(SearchResultBean, Element) -->
                          <UserDataField name="Name">"Value"</UserDataField>
                  <UserData/>
   </wc:InventoryBalance>
   
  

  Parameters:

  abnInventoryItemSearchResult - The bean which contains the Inventory Balance information.

  Returns:

  The InventoryBalance element created.

  Throws:

  ECException

  javax.naming.NamingException

  javax.ejb.FinderException

  javax.ejb.CreateException

  java.rmi.RemoteException

  See Also:

  createItemElement(InventoryFFCSearchResultDataBean, AttributeValueDataBean[], Element), createSiteElement(InventoryFFCSearchResultDataBean, Element), TelesalesResponseBuilderImpl.createUserDataElement(SearchResultBean, Element)

• initializeInventoryBalanceSearch

  protected void initializeInventoryBalanceSearch(com.ibm.commerce.inventory.beans.InventorySearchResultListDataBean abnIventorySearch,
                                      SearchCriteria aSearchCriteria)
  

  This method initializes the search bean with the given search criteria.

  Parameters:

  abnIventorySearch - The InventorySearchResultListDataBean bean.

  aSearchCriteria - The bean which contains the search criteria.

• populateSearchResult

  protected TypedProperty populateSearchResult(TypedProperty hshFFCenterInventory,
                                   com.ibm.commerce.inventory.beans.InventoryFFCSearchResultDataBean abnSearchResult,
                                   boolean bnIsForExpectedInventory)
                                        throws ECException
  

  This method populates the search result for the given category entry Id (item). This method initializes and activates the following data beans for the catentryId within the search result bean:

  • ItemDataBean
  • AttributeValueDataBean

  Parameters:

  hshFFCenterInventory - TypedProperty of the FFCenters included in the inventory.

  abnSearchResult - The InventoryFFCSearchResultDataBeans which contain the expected and on hand inventory.

  bnIsForExpectedInventory - An indicator of whether InventoryFFCSearchResultDataBeans is for expected inventory or on hand (available) inventory.

  Returns:

  A hashtable of FFCenters and item inventory search bean

  Throws:

  ECException

• executeGetInventoryBalance

  protected java.util.ArrayList executeGetInventoryBalance(SearchCriteria aSearchCriteria)
                                                    throws ECException
  

  This method gets the list of Inventory Balances that meets the given search criteria.

  Parameters:

  aSearchCriteria - The given search criteria.

  Returns:

  A list of InventorySearchResultBean that meets the search criteria.

  Throws:

  ECException

• getRootElementName

  protected java.lang.String getRootElementName()
  

  This method gets the root element name of the response document. Value is BodConstants.TAG_WC_SHOW_INVENTORY_BALANCE.

  Specified by:

  getRootElementName in class TelesalesResponseBuilderImpl

  Returns:

  The root element name.

• getCacheableCommand

  public ITelesalesResponseCacheableCommand getCacheableCommand()
                                                         throws ECException
  

  This method returns an initialized cacheable command.

  Specified by:

  getCacheableCommand in interface ITelesalesResponseBuilder

  Overrides:

  getCacheableCommand in class TelesalesResponseBuilderImpl

  Returns:

  The cacheable command object.

  Throws:

  ECException

  See Also:

  ITelesalesResponseBuilder.getCacheableCommand()