OSID Logo
OSID Specifications
dictionary batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.batch.EntryPeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (epl.hasNext()) {
                          EntryPeer peer = epl.getNextEntryPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (epl.hasNext()) {
                          EntryPeer[] peers = cpl.getNextEntryPeers(epl.available());
                     }
                     
                                 
                     
                
MethodgetNextEntryPeer
Description

Gets the next EntryPeer in this list.

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

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

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