org.osid.control

Interface SystemNodeList

All Superinterfaces:

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

public interface SystemNodeList
extends OsidList

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

       
       
       while (snl.hasNext()) {
            SystemNode node = snl.getNextSystemNode();
       }
       
                   
       
  

or

       
       
       while (snl.hasNext()) {
            SystemNode[] nodes = snl.getNextSystemNodes(snl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextSystemNode

SystemNode getNextSystemNode()
                             throws OperationFailedException

Gets the next SystemNode in this list.

Returns:

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

getNextSystemNodes

SystemNode[] getNextSystemNodes(long n)
                                throws OperationFailedException

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

Parameters:

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

Returns:

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