OSID Logo
OSID Specifications
rules check package
Version 3.1.0
Interfaceosid.rules.check.InstructionSearchResults
Implementsosid.OsidSearchResults
Used Byosid.rules.check.InstructionSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetInstructions
Description

Gets the instruction list resulting from a search.

Returnosid.rules.check.InstructionList the instruction list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetInstructionQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.rules.check.InstructionQueryInspector the instruction query inspector
Compliancemandatory This method must be implemented.
MethodgetInstructionSearchResultsRecord
Description

Gets the instruction search results record corresponding to the given instruction search record Type.This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeinstructionSearchRecordType an instruction search record type
Returnosid.rules.check.records.InstructionSearchResultsRecord the instruction search results record
ErrorsNULL_ARGUMENT instructionSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(instructionSearchRecordType) is false
Compliancemandatory This method must be implemented.