OSID Logo
OSID Specifications
course syllabus batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.syllabus.batch.DocetPeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (dpl.hasNext()) {
                          DocetPeer peer = dpl.getNextDocetPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (dpl.hasNext()) {
                          DocetPeer[] peers = dpl.getNextDocetPeers(dpl.available());
                     }
                     
                                 
                     
                
MethodgetNextDocetPeer
Description

Gets the next DocetPeer in this list.

Returnosid.course.syllabus.batch.DocetPeerthe next DocetPeer in this list. The hasNext() method should be used to test that a next DocetPeer is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextDocetPeers
Description

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

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