SearchItemIterator Class

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

public class SearchItemIterator

    extends CatalogItemIterator

A ViewIterator over a set of ProductItems that are the results of a Product Catalog search.

Related Topics

View
ViewIterator
CatalogItemIterator


Hierarchy
Object
  CatalogItemIterator
    SearchItemIterator
All Implemented Interfaces

Serializable, ViewIterator

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 from  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 from  com.beasys.commerce.ebusiness.catalog.CatalogItemIterator
getCatalogManager, getCatalogQueryManager, getCatalogRequest, getCategoryManager, getCurrentView, getCustomDataManager, getProductItemManager, getViewAt, getViewCount, gotoNextView, gotoPreviousView, gotoViewAt, hasNext, hasNextView, hasPreviousView, next, size
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   
Methods from interface com.beasys.commerce.ebusiness.catalog.ViewIterator
getCurrentView, getViewAt, getViewCount, gotoNextView, gotoPreviousView, gotoViewAt, hasNext, hasNextView, hasPreviousView, next, size
 

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.
 

Method Detail

getCatalogItem(View, int) Method

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.

Overrides
CatalogItemIterator.getCatalogItem(View, int)

Parameters

view
The current view.
itemIndex
The index of the item to retrieve.

Exceptions

NoSuchElementException
If the item does not exist.

refreshView(View) Method

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.

Overrides
CatalogItemIterator.refreshView(View)

Parameters

view
The view to refresh.

Exceptions

RemoteException
on remote error.