OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.ProductList
Implementsosid.OsidList
Used Byosid.ordering.ProductLookupSession
osid.ordering.ProductQuerySession
osid.ordering.ProductSearchResults
osid.ordering.ProductStoreSession
Description

Like all OsidLists, ProductList provides a means for accessing Product elements sequentially either one at a time or many at a time. Examples:

while (pl.hasNext()) {
     Product product = pl.getNextProduct();
}
                
or
while (pl.hasNext()) {
     Product[] products = pl.getNextProducts(pl.available());
}
                
MethodgetNextProduct
Description

Gets the next Product in this list.

Returnosid.ordering.Product the next Product in this list. The hasNext() method should be used to test that a next Product is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextProducts
Description

Gets the next set of Product elements in this list. The specified amount must be less than or equal to the return from available().

Parameterscardinaln the number of Product elements requested which must be less than or equal to available()
Returnosid.ordering.Product[] an array of Product elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.