OSID Logo
OSID Specifications
course registration batch package
Version 3.1.0
Interfaceosid.course.registration.batch.CourseRegistrationPeerList
Implementsosid.OsidList
Description

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

while (crpl.hasNext()) {
     CourseRegistrationPeer peer = crpl.getNextCourseRegistrationPeer();
}
                
or
while (crpl.hasNext()) {
     CourseRegistrationPeer[] peers = crpl.getNextCourseRegistrationPeers(crpl.available());
}
                
MethodgetNextCourseRegistrationPeer
Description

Gets the next CourseRegistrationPeer in this list.

Returnosid.course.registration.batch.CourseRegistrationPeer the next CourseRegistrationPeer in this list. The hasNext() method should be used to test that a next CourseRegistrationPeer is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextCourseRegistrationPeers
Description

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

Parameterscardinaln the number of CourseRegistrationPeer elements requested which must be less than or equal to available()
Returnosid.course.registration.batch.CourseRegistrationPeer[] an array of CourseRegistrationPeer elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.