Interface RuleSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RuleSearch
extends OsidSearch

The search interface for governing rule searches.

Method Summary

Modifier and Type	Method	Description
RuleSearchRecord	getRuleSearchRecord(Type ruleSearchRecordType)	Gets the rule search record corresponding to the given rule search record Type.
void	orderRuleResults(RuleSearchOrder ruleSearchOrder)	Specify an ordering to the search results.
void	searchAmongRules(IdList ruleIds)	Execute this search among the given list of rules.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongRules

void searchAmongRules(IdList ruleIds)

Execute this search among the given list of rules.

Parameters:

ruleIds - list of rules

Throws:

NullArgumentException - ruleIds is null

Compliance:

mandatory - This method must be implemented.

orderRuleResults

void orderRuleResults(RuleSearchOrder ruleSearchOrder)

Specify an ordering to the search results.

Parameters:

ruleSearchOrder - rule search order

Throws:

NullArgumentException - ruleSearchOrder is null

UnsupportedException - ruleSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRuleSearchRecord

RuleSearchRecord getRuleSearchRecord(Type ruleSearchRecordType)
                              throws OperationFailedException

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.

Parameters:

ruleSearchRecordType - a rule search record type

Returns:

the rule search record

Throws:

NullArgumentException - ruleSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ruleSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.