OSID Logo
OSID Specifications
ordering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.batch.ItemPeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (ipl.hasNext()) {
                          ItemPeer peer = ipl.getNextItemPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ipl.hasNext()) {
                          ItemPeer[] peers = ipl.getNextItemPeers(ipl.available());
                     }
                     
                                 
                     
                
MethodgetNextItemPeer
Description

Gets the next ItemPeer in this list.

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

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

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