OSID Logo
OSID Specifications
tracking batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.batch.IssuePeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (ipl.hasNext()) {
                          IssuePeer peer = ipl.getNextIssuePeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ipl.hasNext()) {
                          IssuePeer[] peers = ipl.getNextIssuePeers(ipl.available());
                     }
                     
                                 
                     
                
MethodgetNextIssuePeer
Description

Gets the next IssuePeer in this list.

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

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

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