OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ProficiencyList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pl.hasNext()) {
                          Proficiency proficiency = pl.getNextProficiency();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Proficiency[] proficiencies = pl.getNextProficiencies(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextProficiency
Description

Gets the next Proficiency in this list.

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

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

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