OSID Logo
OSID Specifications
room squatting batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.squatting.batch.LeasePeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (lpl.hasNext()) {
                          LeasePeer peer = lpl.getNextLeasePeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (lpl.hasNext()) {
                          LeasePeer[] peers = lpl.getNextLeasePeers(lpl.available());
                     }
                     
                                 
                     
                
MethodgetNextLeasePeer
Description

Gets the next LeasePeer in this list.

Returnosid.room.squatting.batch.LeasePeerthe next LeasePeer in this list. The hasNext() method should be used to test that a next LeasePeer is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextLeasePeers
Description

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

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