OSID - osid.room.CampusSearchSession Service Interface Definition

Interface	osid.room.CampusSearchSession
Implements	`osid.room.CampusQuerySession`
Used By	`osid.room.RoomManager`
Used By	`osid.room.RoomProxyManager`
Description	This session provides methods for searching `Campuses` . The search query is constructed using the `CampusQuery` . The campus record `Type` also specifies the record for the campus query. `getCampusesByQuery()` is the basic search method and returns a list of `Campus` elements. A more advanced search may be performed with `getCampusesBySearch()` . It accepts a `CampusSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCampusesBySearch()` returns a `CampusSearchResults` that can be used to access the resulting `CampusList` or be used to perform a search within the result set through `CampusSearch` . Campuses may have a query record indicated by their respective record types. The query record is accessed via the `CampusQuery` . The returns in this session may not be cast directly to these interfaces.
Method	getCampusSearch
Description	Gets a campus search.
Return	`osid.room.CampusSearch`		the campus search
Compliance	`mandatory`		This method must be implemented.
Method	getCampusSearchOrder
Description	Gets a campus search order. The `CampusSearchOrder` is supplied to a `CampusSearch` to specify the ordering of results.
Return	`osid.room.CampusSearchOrder`		the campus search order
Compliance	`mandatory`		This method must be implemented.
Method	getCampusesBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.room.CampusQuery`	`campusQuery`	the campus query
Parameters	`osid.room.CampusSearch`	`campusSearch`	the campus search
Return	`osid.room.CampusSearchResults`		the campus search results
Errors	NULL_ARGUMENT		`campusQuery` or `campusSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`campusQuery` or `campusSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCampusQueryFromInspector
Description	Gets an entry query from an inspector. The inspector is available from an `CampusSearchResults` .
Parameters	`osid.room.CampusQueryInspector`	`campusQueryInspector`	a query inspector
Return	`osid.room.CampusQuery`		the entry query
Errors	NULL_ARGUMENT		`campusQueryInspector` is `null`
Errors	UNSUPPORTED		`campusQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.