OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.InstructionSearchSession
Implementsosid.rules.check.InstructionQuerySession
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.

MethodgetInstructionSearch
Description

Gets an instruction search.

Returnosid.rules.check.InstructionSearchthe instruction search
CompliancemandatoryThis method must be implemented.
MethodgetInstructionSearchOrder
Description

Gets an instruction search order. The InstructionSearchOrder is supplied to an InstructionSearch to specify the ordering of results.

Returnosid.rules.check.InstructionSearchOrderthe instruction search order
CompliancemandatoryThis method must be implemented.
MethodgetInstructionsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.rules.check.InstructionQueryinstructionQuerythe instruction query
osid.rules.check.InstructionSearchinstructionSearchthe instruction search
Returnosid.rules.check.InstructionSearchResultsthe instruction search results
ErrorsNULL_ARGUMENT instructionQuery or instructionSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED instructionQuery or instructionSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetInstructionQueryFromInspector
Description

Gets an instruction query. from an inspector. The inspector is available from an InstructionSearchResults.

Parametersosid.rules.check.InstructionQueryInspectorinstructionQueryInspectoran instruction query inspector
Returnosid.rules.check.InstructionQuerythe instruction query
ErrorsNULL_ARGUMENT instructionQueryInspector is null
UNSUPPORTED instructionQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.