org.osid.room

Interface BuildingList

All Superinterfaces:

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

public interface BuildingList
extends OsidList

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

       
       
       while (bl.hasNext()) {
            Building building = bl.getNextBuilding();
       }
       
                   
       
  

or

       
       
       while (bl.hasNext()) {
            Building[] buildings = bl.getNextBuildings(bl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextBuilding

Building getNextBuilding()
                         throws OperationFailedException

Gets the next Building in this list.

Returns:

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

getNextBuildings

Building[] getNextBuildings(long n)
                            throws OperationFailedException

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

Parameters:

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

Returns:

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