OSID - osid.rules.check.InstructionSearchSession Service Interface Definition

Interface	osid.rules.check.InstructionSearchSession
Implements	`osid.rules.check.InstructionQuerySession`
Used By	`osid.rules.check.RulesCheckManager`
Used By	`osid.rules.check.RulesCheckProxyManager`
Description	This session provides methods for searching among `Instruction` objects. The search query is constructed using the `InstructionQuery`. `getInstructionsByQuery()` is the basic search method and returns a list of `Instructions`. A more advanced search may be performed with `getInstructionsBySearch()`.It accepts an `InstructionSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getInstructionsBySearch()` returns an `InstructionSearchResults` that can be used to access the resulting `InstructionList` or be used to perform a search within the result set through `InstructionSearch`. This session defines views that offer differing behaviors for searching. federated engine view: searches include instructions in engines of which this engine is an ancestor in the engine hierarchy isolated engine view: searches are restricted to instructions in this engine Instructions may have a query record indicated by their respective record types. The query record is accessed via the `InstructionQuery`.
Method	getInstructionSearch
Description	Gets an instruction search.
Return	`osid.rules.check.InstructionSearch`		the instruction search
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionSearchOrder
Description	Gets an instruction search order. The `InstructionSearchOrder` is supplied to an `InstructionSearch` to specify the ordering of results.
Return	`osid.rules.check.InstructionSearchOrder`		the instruction search order
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.rules.check.InstructionQuery`	`instructionQuery`	the instruction query
Parameters	`osid.rules.check.InstructionSearch`	`instructionSearch`	the instruction search
Return	`osid.rules.check.InstructionSearchResults`		the instruction search results
Errors	NULL_ARGUMENT		`instructionQuery` or `instructionSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`instructionQuery` or `instructionSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionQueryFromInspector
Description	Gets an instruction query. from an inspector. The inspector is available from an `InstructionSearchResults`.
Parameters	`osid.rules.check.InstructionQueryInspector`	`instructionQueryInspector`	an instruction query inspector
Return	`osid.rules.check.InstructionQuery`		the instruction query
Errors	NULL_ARGUMENT		`instructionQueryInspector` is `null`
Errors	UNSUPPORTED		`instructionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.