SiblingIterator Class

com.beasys.commerce.ebusiness.catalog.service.category
SiblingIterator Class

public class SiblingIterator

    extends CatalogItemIterator

A SiblingIterator is a ViewIterator over the sibling Category objects for a given Category.

Related Topics

View
ViewIterator
CatalogItemIterator

Hierarchy
Object
  CatalogItemIterator
    SiblingIterator
All Implemented Interfaces

Serializable, ViewIterator

Field Summary
   
Fields from  com.beasys.commerce.ebusiness.catalog.CatalogItemIterator
DEFAULT_VIEW_SIZE, VERBOSE
 

Constructor Summary
SiblingIterator(String manangerJndiName, CatalogRequest catalogRequest, CategoryKey key, int numItems, int viewSize)

SiblingIterator constructor that takes the total number of spanned items, a view size, CategoryKey, and request object.
 

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
 

Constructor Detail

SiblingIterator

public SiblingIterator(String manangerJndiName, 
                       CatalogRequest catalogRequest, 
                       CategoryKey key, 
                       int numItems, 
                       int viewSize)
SiblingIterator constructor that takes the total number of spanned items, a view size, CategoryKey, and request object.
 

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.