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

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

                     
                     
                     while (apl.hasNext()) {
                          ActivityRegistrationPeer peer = apl.getNextActivityRegistrationPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (apl.hasNext()) {
                          ActivityRegistrationPeer[] peers = apl.getNextActivityRegistrationPeers(apl.available());
                     }
                     
                                 
                     
                
MethodgetNextActivityRegistrationPeer
Description

Gets the next ActivityRegistrationPeer in this list.

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

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

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