OSID Logo
OSID Specifications
room squatting package
Version 3.1.0
Interfaceosid.room.squatting.LeaseList
Implementsosid.OsidList
Used Byosid.room.squatting.LeaseCampusSession
osid.room.squatting.LeaseLookupSession
osid.room.squatting.LeaseQuerySession
osid.room.squatting.LeaseSearchResults
Description

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

while (ll.hasNext()) {
     Lease lease = ll.getNextLease();
}
                
or
while (ll.hasNext()) {
     Lease[] leases = ll.getNextLeases(ll.available());
}
                
MethodgetNextLease
Description

Gets the next Lease in this list.

Returnosid.room.squatting.Lease the next Lease in this list. The hasNext() method should be used to test that a next Lease 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.
MethodgetNextLeases
Description

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

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