OSID Logo
OSID Specifications
course requisite package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.requisite.RequisiteList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rl.hasNext()) {
                          Requisite requisite = rl.getNextRequisite();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rl.hasNext()) {
                          Requisite[] requisites = rl.getNextRequisites(rl.available());
                     }
                     
                                 
                     
                
MethodgetNextRequisite
Description

Gets the next Requisite in this list.

Returnosid.course.requisite.Requisitethe next Requisite in this list. The hasNext() method should be used to test that a next Requisite is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextRequisites
Description

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

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