OSID - osid.metering.UtilitySearchSession Service Interface Definition

Interface	osid.metering.UtilitySearchSession
Implements	`osid.metering.UtilityQuerySession`
Description	This session provides methods for searching `Utility` objects. The search query is constructed using the `UtilityQuery.` The utility record `Type` also specifies the recod for the utility query. `getUtilitiesByQuery()` is the basic search method and returns a list of `Utility` elements. A more advanced search may be performed with `getUtilitiesBySearch().` It accepts a `UtilitySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getUtilitiesBySearch()` returns a `UtilitySearchResults` that can be used to access the resulting `UtilityList` or be used to perform a search within the result set through `UtilitySearch.` Utilities may have a query record indicated by their respective record types. The query record is accessed via the `UtilityQuery.` The returns in this session may not be cast directly to these interfaces.
Method	getUtilitySearch
Description	Gets a utility search.
Return	`osid.metering.UtilitySearch`		the utility search
Compliance	`mandatory`		This method must be implemented.
Method	getUtilitySearchOrder
Description	Gets a utility search order. The `UtilitySearchOrder` is supplied to a `UtilitySearch` to specify the ordering of results.
Return	`osid.metering.UtilitySearchOrder`		the utility search order
Compliance	`mandatory`		This method must be implemented.
Method	getUtilitiesBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.metering.UtilityQuery`	`utilityQuery`	the utility query
Parameters	`osid.metering.UtilitySearch`	`utilitySearch`	the utility search
Return	`osid.metering.UtilitySearchResults`		the utility search results
Errors	NULL_ARGUMENT		`utilityQuery` or `utilitySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`utilityQuery` or `utilitySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getUtilityQueryFromInspector
Description	Gets a utility query from an inspector. The inspector is available from a `UtilitySearchResults.`
Parameters	`osid.metering.UtilityQueryInspector`	`utilityQueryInspector`	a utility query inspector
Return	`osid.metering.UtilityQuery`		the utility query
Errors	NULL_ARGUMENT		`utilityQueryInspector` is `null`
Errors	UNSUPPORTED		`utilityQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.