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

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

                     
                     
                     while (arl.hasNext()) {
                          AwardRequirement req = arl.getNextAwardRequirement();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (arl.hasNext()) {
                          AwardRequirement[] reqs = arl.getNextAwardRequirements(arl.available());
                     }
                     
                                 
                     
                
MethodgetNextAwardRequirement
Description

Gets the next AwardRequirement in this list.

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

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

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