org.osid.inventory

Interface StockList

All Superinterfaces:

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

public interface StockList
extends OsidList

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

       
       
       while (sl.hasNext()) {
            Stock stock = sl.getNextStock();
       }
       
                   
       
  

or

       
       
       while (sl.hasNext()) {
            Stock[] stocks = sl.getNextStocks(sl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Stock	getNextStock() Gets the next Stock in this list.
Stock[]	getNextStocks(long n) Gets the next set of Stock 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

getNextStock

Stock getNextStock()
                   throws OperationFailedException

Gets the next Stock in this list.

Returns:

the next Stock in this list. The hasNext() method should be used to test that a next Stock 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.

getNextStocks

Stock[] getNextStocks(long n)
                      throws OperationFailedException

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

Parameters:

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

Returns:

an array of Stock 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.