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

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

                     
                     
                     while (copl.hasNext()) {
                          CourseOfferingPeer peer = copl.getNextCourseOfferingPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (copl.hasNext()) {
                          CourseOfferingPeer[] peers = copl.getNextCourseOfferingPeers(copl.available());
                     }
                     
                                 
                     
                
MethodgetNextCourseOfferingPeer
Description

Gets the next CourseOfferingPeer in this list.

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

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

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