OSID Logo
OSID Specifications
ontology batch package
Version 3.1.0
Interfaceosid.ontology.batch.RelevancyPeerList
Implementsosid.OsidList
Description

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

while (rpl.hasNext()) {
     RelevancyPeer peer = rpl.getNextRelevancyPeer();
}
                
or
while (rpl.hasNext()) {
     RelevancyPeer[] peers = rpl.getNextRelevancyPeers(rpl.available());
}
                
MethodgetNextRelevancyPeer
Description

Gets the next RelevancyPeer in this list.

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

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

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