OSID Logo
OSID Specifications
course chronicle batch package
Version 3.1.0
Interfaceosid.course.chronicle.batch.AwardEntryPeerList
Implementsosid.OsidList
Description

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

while (apl.hasNext()) {
     AwardEntryPeer peer = apl.getNextAwardEntryPeer();
}
                
or
while (apl.hasNext()) {
     AwardEntryPeer[] peers = apl.getNextAwardEntryPeers(apl.available());
}
                
MethodgetNextAwardEntryPeer
Description

Gets the next AwardEntryPeer in this list.

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

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

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