org.osid.room

Interface CampusNodeList

All Superinterfaces:

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

public interface CampusNodeList
extends OsidList

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

       
       
       while (cnl.hasNext()) {
            CampusNode node = cnl.getNextCampusNode();
       }
       
                   
       
  

or

       
       
       while (cnl.hasNext()) {
            CampusNode[] nodes = cnl.getNextCampusNodes(cnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCampusNode

CampusNode getNextCampusNode()
                             throws OperationFailedException

Gets the next CampusNode in this list.

Returns:

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

getNextCampusNodes

CampusNode[] getNextCampusNodes(long n)
                                throws OperationFailedException

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

Parameters:

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

Returns:

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