org.osid.resourcing

Interface AvailabilityList

All Superinterfaces:

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

public interface AvailabilityList
extends OsidList

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

       
       
       while (al.hasNext()) {
            Availability availability = al.getNextAvailability();
       }
       
                   
       
  

or

       
       
       while (al.hasNext()) {
            Availability[] availabilities = al.getNextAvailabilitys(al.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Availability[]	getNextAvailabilities(long n) Gets the next set of Availability elements in this list.
Availability	getNextAvailability() Gets the next Availability 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

getNextAvailability

Availability getNextAvailability()
                                 throws OperationFailedException

Gets the next Availability in this list.

Returns:

the next Availability in this list. The hasNext() method should be used to test that a next Availability 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.

getNextAvailabilities

Availability[] getNextAvailabilities(long n)
                                     throws OperationFailedException

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

Parameters:

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

Returns:

an array of Availability 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.