org.osid.control.rules

Interface TriggerEnablerSearchOrder

All Superinterfaces:

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

public interface TriggerEnablerSearchOrder
extends OsidEnablerSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
TriggerEnablerSearchOrderRecord	getTriggerEnablerSearchOrderRecord(Type triggerEnablerRecordType) Gets the trigger enabler search order record corresponding to the given trigger enabler record Type.

Methods inherited from interface org.osid.OsidEnablerSearchOrder

getCyclicEventSearchOrder, getDemographicSearchOrder, getEventSearchOrder, getScheduleSearchOrder, orderByCyclicEvent, orderByDemographic, orderByEvent, orderBySchedule, supportsCyclicEventSearchOrder, supportsDemographicSearchOrder, supportsEventSearchOrder, supportsScheduleSearchOrder

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

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

getTriggerEnablerSearchOrderRecord

TriggerEnablerSearchOrderRecord getTriggerEnablerSearchOrderRecord(Type triggerEnablerRecordType)
                                                                   throws OperationFailedException

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

Parameters:

triggerEnablerRecordType - a trigger enabler record type

Returns:

the trigger enabler search order record

Throws:

NullArgumentException - triggerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(triggerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.