public interface RoomList extends OsidList
Like all OsidLists,
RoomList
provides a
means for accessing Room
elements sequentially either one
at a time or many at a time. Examples:
while (rl.hasNext()) { Room room = rl.getNextRoom(); }or
while (rl.hasNext()) { Room[] rooms = rl.getNextRooms(rl.available()); }
Modifier and Type | Method and Description |
---|---|
Room |
getNextRoom()
Gets the next
Room in this list. |
Room[] |
getNextRooms(long n)
Gets the next set of
Room elements in this list. |
Room getNextRoom() throws OperationFailedException
Room
in this list. Room
in this list. The
hasNext()
method should be used to test that a next
Room
is available before calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Room[] getNextRooms(long n) throws OperationFailedException
Room
elements in this list. The
specified amount must be less than or equal to the return from
available().
n
- the number of Room
elements requested which
must be less than or equal to available()
Room
elements.
The
length of the array is less than or equal to the number
specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.