Interface LeaseList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, 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());
}

Like all OsidLists, LeaseList is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • 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.