OSID Logo
OSID Specifications
course syllabus batch package
Version 3.1.0
Interfaceosid.course.syllabus.batch.DocetPeerList
Implementsosid.OsidList
Description

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

while (dpl.hasNext()) {
     DocetPeer peer = dpl.getNextDocetPeer();
}
                
or
while (dpl.hasNext()) {
     DocetPeer[] peers = dpl.getNextDocetPeers(dpl.available());
}
                
MethodgetNextDocetPeer
Description

Gets the next DocetPeer in this list.

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

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

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