OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.CheckSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetChecks
Description

Gets the check list resulting from a search.

Returnosid.rules.check.CheckListthe check list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCheckQueryInspector
Description

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

Returnosid.rules.check.CheckQueryInspectorthe check query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCheckSearchResultsRecord
Description

Gets the check search results 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.CheckSearchResultsRecordthe check search results 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.