org.osid.rules

Interface RuleSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable

public interface RuleSearchOrder
extends OsidRuleSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
RuleSearchOrderRecord	getRuleSearchOrderRecord(Type ruleRecordType) Gets the rule search order record corresponding to the given rule record Type.

Methods inherited from interface org.osid.OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Method Detail

getRuleSearchOrderRecord

RuleSearchOrderRecord getRuleSearchOrderRecord(Type ruleRecordType)
                                               throws OperationFailedException

Gets the rule search order record corresponding to the given rule record Type. Multiple retrievals return the same underlying object.

Parameters:

ruleRecordType - a rule record type

Returns:

the rule search order record

Throws:

NullArgumentException - ruleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ruleRecordType) is false

Compliance:

mandatory - This method must be implemented.