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

The search interface for governing check searches.

MethodsearchAmongChecks
Description

Execute this search among the given list of checks.

Parametersosid.id.IdListcheckIdslist of checks
ErrorsNULL_ARGUMENT checkIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCheckResults
Description

Specify an ordering to the search results.

Parametersosid.rules.check.CheckSearchOrdercheckSearchOrdercheck search order
ErrorsNULL_ARGUMENT checkSearchOrder is null
UNSUPPORTED checkSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCheckSearchRecord
Description

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

Parametersosid.type.TypecheckSearchRecordTypea check search record type
Returnosid.rules.check.records.CheckSearchRecordthe check search record
ErrorsNULL_ARGUMENT checkSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(checkSearchRecordType) is false
CompliancemandatoryThis method must be implemented.