OSID - osid.room.FloorSearchSession Service Interface Definition

Interface	osid.room.FloorSearchSession
Implements	`osid.room.FloorQuerySession`
Used By	`osid.room.RoomManager`
Used By	`osid.room.RoomProxyManager`
Description	This session provides methods for searching `Floors` . The search query is constructed using the `FloorQuery` . The floor record `Type` also specifies the record for the floor query. `getFloorsByQuery()` is the basic search method and returns a list of `Floor` elements. A more advanced search may be performed with `getFloorsBySearch()` . It accepts a `FloorSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getFlooreBySearch()` returns a `FloorSearchResults` that can be used to access the resulting `FloorList` or be used to perform a search within the result set through `FloorSearch` . Floors may have a query record indicated by their respective record types. The query record is accessed via the `FloorQuery` . The returns in this session may not be cast directly to these interfaces.
Method	getFloorSearch
Description	Gets a floor search.
Return	`osid.room.FloorSearch`		the floor search
Compliance	`mandatory`		This method must be implemented.
Method	getFloorSearchOrder
Description	Gets a floor search order. The `FloorSearchOrder` is supplied to a `FloorSearch` to specify the ordering of results.
Return	`osid.room.FloorSearchOrder`		the floor search order
Compliance	`mandatory`		This method must be implemented.
Method	getFloorsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.room.FloorQuery`	`floorQuery`	the floor query
Parameters	`osid.room.FloorSearch`	`floorSearch`	the floor search
Return	`osid.room.FloorSearchResults`		the floor search results
Errors	NULL_ARGUMENT		`floorQuery` or `floorSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`floorQuery` or `floorSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getFloorQueryFromInspector
Description	Gets an entry query from an inspector. The inspector is available from an `FloorSearchResults` .
Parameters	`osid.room.FloorQueryInspector`	`floorQueryInspector`	a query inspector
Return	`osid.room.FloorQuery`		the entry query
Errors	NULL_ARGUMENT		`floorQueryInspector` is `null`
Errors	UNSUPPORTED		`floorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.