org.osid.room.squatting

Interface LeaseList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface LeaseList
extends OsidList

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());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Lease	getNextLease() Gets the next Lease in this list.
Lease[]	getNextLeases(long n) Gets the next set of Lease elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextLease

Lease getNextLease()
                   throws OperationFailedException

Gets the next Lease in this list.

Returns:

the next Lease in this list. The hasNext() method should be used to test that a next Lease is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextLeases

Lease[] getNextLeases(long n)
                      throws OperationFailedException

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

Parameters:

n - the number of Lease elements requested which must be less than or equal to available()

Returns:

an array of Lease elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.