OSID - osid.room.RoomSearchSession Service Interface Definition

Interface	osid.room.RoomSearchSession
Implements	`osid.room.RoomQuerySession`
Used By	`osid.room.RoomManager`
Used By	`osid.room.RoomProxyManager`
Description	This session provides methods for searching `Rooms` . The search query is constructed using the `RoomQuery` . The room record `Type` also specifies the record for the room query. `getRoomsByQuery()` is the basic search method and returns a list of `Campus` elements. A more advanced search may be performed with `getRoomsBySearch()` . It accepts a `RoomSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRoomsBySearch()` returns a `RoomSearchResults` that can be used to access the resulting `RoomList` or be used to perform a search within the result set through `RoomSearch` . Rooms may have a query record indicated by their respective record types. The query record is accessed via the `RoomQuery` . The returns in this session may not be cast directly to these interfaces.
Method	getRoomSearch
Description	Gets a room search.
Return	`osid.room.RoomSearch`		the room search
Compliance	`mandatory`		This method must be implemented.
Method	getRoomSearchOrder
Description	Gets a room search order. The `RoomSearchOrder` is supplied to a `RoomSearch` to specify the ordering of results.
Return	`osid.room.RoomSearchOrder`		the room search order
Compliance	`mandatory`		This method must be implemented.
Method	getRoomsBySearch
Description	Gets the room search results matching the given search.
Parameters	`osid.room.RoomQuery`	`roomQuery`	the room query
Parameters	`osid.room.RoomSearch`	`roomSearch`	the room search
Return	`osid.room.RoomSearchResults`		the room search results
Errors	NULL_ARGUMENT		`roomQuery` or `roomSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`roomQuery` or `roomSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRoomQueryFromInspector
Description	Gets an entry query from an inspector. The inspector is available from an `RoomSearchResults` .
Parameters	`osid.room.RoomQueryInspector`	`roomQueryInspector`	a query inspector
Return	`osid.room.RoomQuery`		the entry query
Errors	NULL_ARGUMENT		`roomQueryInspector` is `null`
Errors	UNSUPPORTED		`roomQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.