Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM Copyright notice field

  See Also:

  Constant Field Values

• iDataAreaElement

  protected org.w3c.dom.Element iDataAreaElement
  

  iDataAreaElement contains the response document's DataArea element. It is initialized in buildDataArea method.

Constructor Detail

• ShowPriceList

  public ShowPriceList()
  

  Default constructor.

Method Detail

• buildDataArea

  protected void buildDataArea()
                        throws ECException
  

  This method builds the Data Area subsection of the reply BOD. It calls executeGetFloorPrice to obtain a list of FloorPriceDataBean. For each FloorPriceDataBean returned, it then calls createPriceListElement to create the PriceList element.

  The following outline shows the structure of the DataArea element and its construction:

         <DataArea>
            <Show> 
               .
               .
            </Show>
            <PriceList> <!-- constructed by createPriceListElement() -->
               .
               .
            </PriceList>
         </DataArea>
   
  

  Specified by:

  buildDataArea in class TelesalesResponseBuilderImpl

  Throws:

  ECException - An ECSystemException will be thrown when error occurs.

• executeGetFloorPrice

  protected java.util.ArrayList executeGetFloorPrice(org.w3c.dom.Document requestBod)
                                              throws ECException
  

  This method gets the list of price list search results that meet the search criteria in the given request Business Object Document. Note that only searches using searchType =ExactMatch and name =CATID are supported. All other combinations will be ignored.

  Parameters:

  requestBod - The request Business Object Document contains the search criteria.

  Returns:

  A list of PriceListSearchResultBean that meet the search criteria.

  Throws:

  ECException - An ECSystemException will be thrown when error occurs.

• executeGetFloorPrice

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

  This method gets the list of floor prices that meet the given search criteria.

  Parameters:

  aSearchCriteria - The given search criteria.

  Returns:

  A list of PriceListSearchResultBean that meet the search criteria.

  Throws:

  ECException - An ECSystemException will be thrown when error occurs.

• createFloorPriceDataBean

  protected FloorPriceDataBean createFloorPriceDataBean()
  

  This method creates a FloorPriceDataBean to be used to do price list search.

  Returns:

  The FloorPriceDataBean created.

• initializeFloorPriceDataBean

  protected void initializeFloorPriceDataBean(FloorPriceDataBean floorPriceDataBean,
                                  SelectExpression catIdExpression,
                                  SelectExpression currencyExpression)
  

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

  Parameters:

  floorPriceDataBean - The bean which does the floor price search.

  catIdExpression - The bean which contains the search criteria with the catalog entry id.

  currencyExpression - The bean which contains the search criteria with the currency.

• populateSearchResult

  protected PriceListSearchResultBean populateSearchResult(FloorPriceDataBean abnFloorPrice,
                                               PriceListSearchResultBean abnSearchResult)
                                                    throws ECException
  

  This method populates the search result for the given comment. The customer comment data bean is stored in the search result bean. Override this method if you need to store additional data in the search result.

  Parameters:

  abnFloorPrice - The floor price data bean.

  abnSearchResult - The search result needs to be populated.

  Returns:

  The populated search result.

  Throws:

  ECException

• getRootElementName

  protected java.lang.String getRootElementName()
  

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

  Specified by:

  getRootElementName in class TelesalesResponseBuilderImpl

  Returns:

  The root element name ShowPriceList

• createPriceListElement

  protected org.w3c.dom.Element createPriceListElement(PriceListSearchResultBean abnPriceListSearchResult)
                                                throws ECException
  

  This method builds the PriceList element and all its descendent elements. This method creates PriceList element and its Header sub-element. The following subelements of Header are created as well. DocumentId element and its subelement Id ListPriceBreak element and its subelements PriceBreakAmount> and UserArea

  Parameters:

  abnPriceListSearchResult - The search result bean which contains the floor price information.

  Returns:

  The PriceList element created.

  Throws:

  ECException - An ECSystemException will be thrown when error occurs.

  See Also:

  TelesalesResponseBuilderImpl.createUserDataElement(com.ibm.commerce.telesales.messaging.beans.SearchResultBean, org.w3c.dom.Element)