org.osid.personnel

Interface RealmList

All Superinterfaces:

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

public interface RealmList
extends OsidList

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

       
       
       while (rl.hasNext()) {
            Realm realm = rl.getNextRealm();
       }
       
                   
       
  

or

       
       
       while (rl.hasNext()) {
            Realm[] realm = rl.getNextRealms(rl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextRealm

Realm getNextRealm()
                   throws OperationFailedException

Gets the next Realm in this list.

Returns:

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

getNextRealms

Realm[] getNextRealms(long n)
                      throws OperationFailedException

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

Parameters:

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

Returns:

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