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

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

                     
                     
                     while (cpl.hasNext()) {
                          CourseEntryPeer peer = cpl.getNextCourseEntryPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cpl.hasNext()) {
                          CourseEntryPeer[] peers = cpl.getNextCourseEntryPeers(cpl.available());
                     }
                     
                                 
                     
                
MethodgetNextCourseEntryPeer
Description

Gets the next CourseEntryPeer in this list.

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

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

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