Overview | Package | Class | Tree | Deprecated | Index | Help
| Copyright © 2006 BEA Systems, Inc. All Rights Reserved
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.beasys.commerce.ebusiness.catalog.service.query
Class SearchItemIterator

    java.lang.Object
      com.beasys.commerce.ebusiness.catalog.CatalogItemIterator
          com.beasys.commerce.ebusiness.catalog.service.query.SearchItemIterator

All Implemented Interfaces
  ViewIterator, Serializable

    public class SearchItemIterator

extends CatalogItemIterator

A `ViewIterator` over a set of `ProductItem`s that are the results of a Product Catalog search.

See Also
  `View`, `ViewIterator`, `CatalogItemIterator`, Serialized Form

Field Summary
`protected ProductItemKey[]` | `allKeys` The product item identifiers that matched a search.
`protected ProductItem[]` | `items` The current view's items.
`protected ProductItemKey[]` | `keys` The current view's keys.

Fields inherited from class com.beasys.commerce.ebusiness.catalog.CatalogItemIterator
`DEFAULT_VIEW_SIZE, VERBOSE`

Constructor Summary
`SearchItemIterator(String manangerJndiName, CatalogRequest catalogRequest, ProductItemKey[] keys, int viewSize)` Constructor.

Method Summary
`protected CatalogItem` | `getCatalogItem(View view, int itemIndex)` Returns a CatalogItem within the current view.
`protected void` | `refreshView(View view)` This function is called whenever the current view needs to be refreshed.

Methods inherited from class com.beasys.commerce.ebusiness.catalog.CatalogItemIterator
`getCatalogManager, getCatalogQueryManager, getCatalogRequest, getCategoryManager, getCurrentView, getCustomDataManager, getProductItemManager, getViewAt, getViewCount, gotoNextView, gotoPreviousView, gotoViewAt, hasNext, hasNextView, hasPreviousView, next, size`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### allKeys

    protected ProductItemKey[] allKeys

  The product item identifiers that matched a search.

### items

    protected ProductItem[] items

  The current view's items.

### keys

    protected ProductItemKey[] keys

  The current view's keys.

Constructor Detail

### SearchItemIterator

    public SearchItemIterator(String manangerJndiName,
                              CatalogRequest catalogRequest,
                              ProductItemKey[] keys,
                              int viewSize)

  Constructor.

  Parameters
    `managerHandle` - handle to the ProductItemManager.
    `request` - the CatalogRequest.
    `keys` - the product item keys.
    `viewSize` - the size of the views.

Method Detail

### refreshView

    protected void refreshView(View view)
                        throws RemoteException

  This function is called whenever the current view needs to be refreshed. All classes that extend this class must implement this function.

  Specified by:
    `refreshView` in class `CatalogItemIterator`
  Parameters
    `view` - The view to refresh.
  Throws
    `RemoteException` - on remote error.

### getCatalogItem

    protected CatalogItem getCatalogItem(View view,
                                         int itemIndex)
                                  throws NoSuchElementException

  Returns a CatalogItem within the current view. All classes that extend this class must implement this function.

  Specified by:
    `getCatalogItem` in class `CatalogItemIterator`
  Parameters
    `view` - The current view.
    `itemIndex` - The index of the item to retrieve.
  Throws
    `NoSuchElementException` - If the item does not exist.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2006 BEA Systems, Inc. All Rights Reserved