org.osid.ordering

Interface ProductList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface ProductList
extends OsidList

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());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Product	getNextProduct() Gets the next Product in this list.
Product[]	getNextProducts(long n) Gets the next set of Product elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextProduct

Product getNextProduct()
                       throws OperationFailedException

Gets the next Product in this list.

Returns:

the next Product in this list. The hasNext() method should be used to test that a next Product is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextProducts

Product[] getNextProducts(long n)
                          throws OperationFailedException

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

Parameters:

n - the number of Product elements requested which must be less than or equal to available()

Returns:

an array of Product elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.