org.osid.installation

Interface DepotNodeList

All Superinterfaces:

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

public interface DepotNodeList
extends OsidList

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

       
       
       while (dnl.hasNext()) {
            DepotNode node = dnl.getNextDepotNode();
       }
       
                   
       
  

or

       
       
       while (dnl.hasNext()) {
            DepotNode[] nodes = dnl.getNextDepotNodes(dnl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
DepotNode	getNextDepotNode() Gets the next DepotNode in this list.
DepotNode[]	getNextDepotNodes(long n) Gets the next set of DepotNode elements in this list which must be less than or equal to the return from available().

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

getNextDepotNode

DepotNode getNextDepotNode()
                           throws OperationFailedException

Gets the next DepotNode in this list.

Returns:

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

getNextDepotNodes

DepotNode[] getNextDepotNodes(long n)
                              throws OperationFailedException

Gets the next set of DepotNode elements in this list which must be less than or equal to the return from available().

Parameters:

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

Returns:

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