OSID Logo
OSID Specifications
rules check package
Version 3.1.0
Interfaceosid.rules.check.CheckSearchResults
Implementsosid.OsidSearchResults
Used Byosid.rules.check.CheckSearchSession
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.CheckList the check list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetCheckQueryInspector
Description

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

Returnosid.rules.check.CheckQueryInspector the check query inspector
Compliancemandatory This 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.TypecheckSearchRecordType a check search record type
Returnosid.rules.check.records.CheckSearchResultsRecord the check search results record
ErrorsNULL_ARGUMENT checkSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(checkSearchRecordType) is false
Compliancemandatory This method must be implemented.