OSID - osid.room.RoomList Service Interface Definition

Interface	osid.room.RoomList
Implements	`osid.OsidList`
Used By	`osid.room.Room`
	`osid.room.RoomCampusSession`
	`osid.room.RoomLookupSession`
	`osid.room.RoomQuerySession`
	`osid.room.RoomSearchResults`
	`osid.room.construction.Renovation`
Description	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()); }
Method	getNextRoom
Description	Gets the next `Room` in this list.
Return	`osid.room.Room`		the next `Room` in this list. The `hasNext()` method should be used to test that a next `Room` is available before calling this method.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getNextRooms
Description	Gets the next set of `Room` elements in this list. The specified amount must be less than or equal to the return from `available()` .
Parameters	`cardinal`	`n`	the number of `Room` elements requested which must be less than or equal to `available()`
Return	`osid.room.Room[]`		an array of `Room` elements. The length of the array is less than or equal to the number specified.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.