OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.InstructionSearchResults
Implementsosid.OsidSearchResults
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.InstructionListthe instruction list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetInstructionQueryInspector
Description

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

Returnosid.rules.check.InstructionQueryInspectorthe instruction query inspector
CompliancemandatoryThis 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.TypeinstructionSearchRecordTypean instruction search record type
Returnosid.rules.check.records.InstructionSearchResultsRecordthe instruction search results record
ErrorsNULL_ARGUMENT instructionSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(instructionSearchRecordType) is false
CompliancemandatoryThis method must be implemented.