org.osid.inventory

Interface StockNodeList

All Superinterfaces:

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

public interface StockNodeList
extends OsidList

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

       
       
       while (snl.hasNext()) {
            StockNode node = snl.getNextStockNode();
       }
       
                   
       
  

or

       
       
       while (snl.hasNext()) {
            StockNode[] nodes = snl.getNextStockNodes(snl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextStockNode

StockNode getNextStockNode()
                           throws OperationFailedException

Gets the next StockNode in this list.

Returns:

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

getNextStockNodes

StockNode[] getNextStockNodes(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

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