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

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

while (ppl.hasNext()) {
     ProgramEntryPeer peer = ppl.getNextProgramEntryPeer();
}
                
or
while (ppl.hasNext()) {
     ProgramEntryPeer[] peers = ppl.getNextProgramEntryPeers(ppl.available());
}
                
MethodgetNextProgramEntryPeer
Description

Gets the next ProgramEntryPeer in this list.

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

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

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