OSID Logo
OSID Specifications
rules package
Version 3.1.0
Interfaceosid.rules.RuleSearchResults
Implementsosid.OsidSearchResults
Used Byosid.rules.RuleSearchSession
Description

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

MethodgetRules
Description

Gets the rule list resulting from a search.

Returnosid.rules.RuleList the rule list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetRuleQueryInspector
Description

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

Returnosid.rules.RuleQueryInspector the rule query inspector
Compliancemandatory This method must be implemented.
MethodgetRuleSearchResultsRecord
Description

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

Parametersosid.type.TyperuleSearchRecordType a rule search record type
Returnosid.rules.records.RuleSearchResultsRecord the rule search results record
ErrorsNULL_ARGUMENT ruleSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(ruleSearchRecordType) is false
Compliancemandatory This method must be implemented.