OSID - osid.rules.RuleSearchSession Service Interface Definition

Interface	osid.rules.RuleSearchSession
Implements	`osid.rules.RuleQuerySession`
Description	This session provides methods for searching `Rule` objects. The search query is constructed using the `RuleQuery.` The rule record `Type` also specifies the record for the rule query. `getRulesByQuery()` is the basic search method and returns a list of `Rule` elements. A more advanced search may be performed with `getRulesBySearch().` It accepts a `RuleSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRulesBySearch()` returns a `RuleSearchResults` that can be used to access the resulting `RuleList` or be used to perform a search within the result set through `RuleSearch.` Rules may have a query record indicated by their respective record types. The rule query record is accessed via the `RuleQuery.` The returns in this session may not be cast directly to these interfaces.
Method	getRuleSearch
Description	Gets a rule search.
Return	`osid.rules.RuleSearch`		the rule search
Compliance	`mandatory`		This method must be implemented.
Method	getRuleSearchOrder
Description	Gets a rule search order. The `RuleSearchOrder` is supplied to a `RuleSearch` to specify the ordering of results.
Return	`osid.rules.RuleSearchOrder`		the rule search order
Compliance	`mandatory`		This method must be implemented.
Method	getRulesBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.rules.RuleQuery`	`ruleQuery`	the rule query
Parameters	`osid.rules.RuleSearch`	`ruleSearch`	the rule search
Return	`osid.rules.RuleSearchResults`		the search results
Errors	NULL_ARGUMENT		`ruleQuery` or `ruleSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`ruleQuery` or `ruleSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRuleQueryFromInspector
Description	Gets a rule query from an inspector. The inspector is available from a `RuleSearchResults.`
Parameters	`osid.rules.RuleQueryInspector`	`ruleQueryInspector`	a rule query inspector
Return	`osid.rules.RuleQuery`		the rule query
Errors	NULL_ARGUMENT		`ruleQueryInspector` is `null`
Errors	UNSUPPORTED		`ruleQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.