org.osid.resource

Interface ResourceNodeList

All Superinterfaces:

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

public interface ResourceNodeList
extends OsidList

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

       
       
       while (rnl.hasNext()) {
            ResourceNode node = rnl.getNextResourceNode();
       }
       
                   
       
  

or

       
       
       while rnl.hasNext()) {
            ResourceNode[] nodes = rnl.getNextResourceNodes(rnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextResourceNode

ResourceNode getNextResourceNode()
                                 throws OperationFailedException

Gets the next ResourceNode in this list.

Returns:

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

getNextResourceNodes

ResourceNode[] getNextResourceNodes(long n)
                                    throws OperationFailedException

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

Parameters:

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

Returns:

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