OSID - osid.metering.MeterSearchSession Service Interface Definition

Interface	osid.metering.MeterSearchSession
Implements	`osid.metering.MeterQuerySession`
Description	This session provides methods for searching among meters. The search query is constructed using the `MeterQuery.` `getMetersByQuery()` is the basic search method and returns a list of meters. A more advanced search may be performed with `getMetersBySearch().` It accepts a `MeterSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getMetersBySearch()` returns a `MeterSearchResults` that can be used to access the resulting `MeterList` or be used to perform a search within the result set through `MeterSearch.` This session defines views that offer differing behaviors for searching. federated utility view: searches include meters in utilities of which this utility is an ancestor in the utility hierarchy isolated utility view: searches are restricted to meters in this utility only
Method	getMeterSearch
Description	Gets a meter search.
Return	`osid.metering.MeterSearch`		the meter search
Compliance	`mandatory`		This method must be implemented.
Method	getMeterSearchOrder
Description	Gets a meter search order. The `MeterSearchOrder` is supplied to a `MeterSearch` to specify the ordering of results.
Return	`osid.metering.MeterSearchOrder`		the meter search order
Compliance	`mandatory`		This method must be implemented.
Method	getMetersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.metering.MeterQuery`	`meterQuery`	the meter query
Parameters	`osid.metering.MeterSearch`	`meterSearch`	the meter search
Return	`osid.metering.MeterSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`meterQuery` or `meterSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`meterQuery` or `meterSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getMeterQueryFromInspector
Description	Gets a meter query from an inspector. The inspector is available from a `MeterSearchResults.`
Parameters	`osid.metering.MeterQueryInspector`	`meterQueryInspector`	a meter query inspector
Return	`osid.metering.MeterQuery`		the meter query
Errors	NULL_ARGUMENT		`meterQueryInspector` is `null`
Errors	UNSUPPORTED		`meterQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.