OSID Logo
OSID Specifications
recognition batch package
Version 3.1.0
Interfaceosid.recognition.batch.ConferralPeerList
Implementsosid.OsidList
Description

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

while (cpl.hasNext()) {
     ConferralPeer peer = cpl.getConferralPeer();
}
                
or
while (cpl.hasNext()) {
     ConferralPeer[] peers = cbfl.getNextConferralPeers(cpl.available());
}
                
MethodgetNextConferralPeer
Description

Gets the next ConferralPeer in this list.

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

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

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