OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.CampusList
Implementsosid.OsidList
Description

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

                     
                     
                     while (cl.hasNext()) {
                          Campus campus = cl.getNextCampus();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Campus[] campuses = cl.getNextCampuses(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextCampus
Description

Gets the next Campus in this list.

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

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

Parameterscardinalnthe number of Campus elements requested which must be less than or equal to available()
Returnosid.room.Campus[]an array of Campus 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.