OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.RealmList
Implementsosid.OsidList
Description

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());
                     }
                     
                                 
                     
                
MethodgetNextRealm
Description

Gets the next Realm in this list.

Returnosid.personnel.Realmthe next Realm in this list. The hasNext() method should be used to test that a next Realm is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextRealms
Description

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

Parameterscardinalnthe number of Realm elements requested which must be less than or equal to available()
Returnosid.personnel.Realm[]an array of Realm elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.