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

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

                     
                     
                     while (apl.hasNext()) {
                          ActivityPeer peer = apl.getNextActivityPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (apl.hasNext()) {
                          ActivityPeer[] peers = apl.getNextActivityPeers(apl.available());
                     }
                     
                                 
                     
                
MethodgetNextActivityPeer
Description

Gets the next ActivityPeer in this list.

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

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

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