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

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

Gets the next CampusNode in this list.

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

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

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