org.osid.ordering

Interface StoreNodeList

All Superinterfaces:

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

public interface StoreNodeList
extends OsidList

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

       
       
       while (snl.hasNext()) {
            StoreNode node = snl.getNextStoreNode();
       }
       
                   
       
  

or

       
       
       while (snl.hasNext()) {
            StoreNode[] nodes = snl.getNextStoreNodes(snl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextStoreNode

StoreNode getNextStoreNode()
                           throws OperationFailedException

Gets the next StoreNode in this list.

Returns:

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

getNextStoreNodes

StoreNode[] getNextStoreNodes(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

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