org.osid.calendaring.rules

Interface RecurringEventEnablerSearchOrder

All Superinterfaces:

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

public interface RecurringEventEnablerSearchOrder
extends OsidEnablerSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
RecurringEventEnablerSearchOrderRecord	getRecurringEventEnablerSearchOrderRecord(Type recurringEventEnablerRecordType) Gets the recurring event enabler search order record corresponding to the given recurring event 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

getRecurringEventEnablerSearchOrderRecord

RecurringEventEnablerSearchOrderRecord getRecurringEventEnablerSearchOrderRecord(Type recurringEventEnablerRecordType)
                                                                                 throws OperationFailedException

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

Parameters:

recurringEventEnablerRecordType - an recurring event enabler record type

Returns:

the recurring event enabler search order record

Throws:

NullArgumentException - recurringEventEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(recurringEventEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.