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

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

MethodgetRules
Description

Gets the rule list resulting from a search.

Returnosid.rules.RuleListthe rule list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetRuleQueryInspector
Description

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

Returnosid.rules.RuleQueryInspectorthe rule query inspector
CompliancemandatoryThis 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.TyperuleSearchRecordTypea rule search record type
Returnosid.rules.records.RuleSearchResultsRecordthe rule search results record
ErrorsNULL_ARGUMENT ruleSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(ruleSearchRecordType) is false
CompliancemandatoryThis method must be implemented.