org.osid.resourcing

Interface FoundryNodeList

All Superinterfaces:

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

public interface FoundryNodeList
extends OsidList

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

       
       
       while (fnl.hasNext()) {
            FoundryNode node = fnl.getNextFoundryNode();
       }
       
                   
       
  

or

       
       
       while (fnl.hasNext()) {
            FoundryNode[] nodes = fnl.getNextFoundryNodes(fnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextFoundryNode

FoundryNode getNextFoundryNode()
                               throws OperationFailedException

Gets the next FoundryNode in this list.

Returns:

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

getNextFoundryNodes

FoundryNode[] getNextFoundryNodes(long n)
                                  throws OperationFailedException

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

Parameters:

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

Returns:

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