OSID Logo
OSID Specifications
rules check package
Version 3.1.0
Interfaceosid.rules.check.InstructionSearch
Implementsosid.OsidSearch
Used Byosid.rules.check.InstructionSearchSession
Description

The search interface for governing instruction searches.

MethodsearchAmongInstructions
Description

Execute this search among the given list of instructions.

Parametersosid.id.IdListinstructionIds list of instructions
ErrorsNULL_ARGUMENT instructionIds is null
Compliancemandatory This method must be implemented.
MethodorderInstructionResults
Description

Specify an ordering to the search results.

Parametersosid.rules.check.InstructionSearchOrderinstructionSearchOrder instruction search order
ErrorsNULL_ARGUMENT instructionSearchOrder is null
UNSUPPORTED instructionSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetInstructionSearchRecord
Description

Gets the instruction search 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.InstructionSearchRecord the instruction search 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.