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

The search interface for governing rule searches.

MethodsearchAmongRules
Description

Execute this search among the given list of rules.

Parametersosid.id.IdListruleIdslist of rules
ErrorsNULL_ARGUMENT ruleIds is null
CompliancemandatoryThis method must be implemented.
MethodorderRuleResults
Description

Specify an ordering to the search results.

Parametersosid.rules.RuleSearchOrderruleSearchOrderrule search order
ErrorsNULL_ARGUMENT ruleSearchOrder is null
UNSUPPORTED ruleSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRuleSearchRecord
Description

Gets the rule search 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.RuleSearchRecordthe rule search record
ErrorsNULL_ARGUMENT ruleSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(ruleSearchRecordType) is false
CompliancemandatoryThis method must be implemented.