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

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

                     
                     
                     while (ppl.hasNext()) {
                          ProficiencyPeer peer = ppl.getNextProficiencyPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ppl.hasNext()) {
                          ProficiencyPeer[] peers = ppl.getNextProficiencyPeers(epl.available());
                     }
                     
                                 
                     
                
MethodgetNextProficiencyPeer
Description

Gets the next ProficiencyPeer in this list.

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

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

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