OSID Logo
OSID Specifications
course registration batch package
Version 3.1.0
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 (arpl.hasNext()) {
     ActivityRegistrationPeer peer = arpl.getNextActivityRegistrationPeer();
}
                
or
while (arpl.hasNext()) {
     ActivityRegistrationPeer[] peers = arpl.getNextActivityRegistrationPeers(arpl.available());
}
                
MethodgetNextActivityRegistrationPeer
Description

Gets the next ActivityRegistrationPeer in this list.

Returnosid.course.registration.batch.ActivityRegistrationPeer the next ActivityRegistrationPeer in this list. The hasNext() method should be used to test that a next ActivityRegistrationPeer 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.
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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.