org.osid.personnel

Interface RealmNodeList

All Superinterfaces:

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

public interface RealmNodeList
extends OsidList

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

       
       
       while (rnl.hasNext()) {
            RealmNode node = rnl.getNextRealmNode();
       }
       
                   
       
  

or

       
       
       while (rnl.hasNext()) {
            RealmNode[] nodes = rnl.getNextRealmNodes(rnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextRealmNode

RealmNode getNextRealmNode()
                           throws OperationFailedException

Gets the next RealmNode in this list.

Returns:

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

getNextRealmNodes

RealmNode[] getNextRealmNodes(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

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