OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.InstructionSearch
Implementsosid.OsidSearch
Description

The search interface for governing instruction searches.

MethodsearchAmongInstructions
Description

Execute this search among the given list of instructions.

Parametersosid.id.IdListinstructionIdslist of instructions
ErrorsNULL_ARGUMENT instructionIds is null
CompliancemandatoryThis method must be implemented.
MethodorderInstructionResults
Description

Specify an ordering to the search results.

Parametersosid.rules.check.InstructionSearchOrderinstructionSearchOrderinstruction search order
ErrorsNULL_ARGUMENT instructionSearchOrder is null
UNSUPPORTED instructionSearchOrder is not of this service
CompliancemandatoryThis 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.TypeinstructionSearchRecordTypean instruction search record type
Returnosid.rules.check.records.InstructionSearchRecordthe instruction search 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.