org.osid.calendaring

Interface RecurringEventSearchOrder

All Superinterfaces:

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

public interface RecurringEventSearchOrder
extends OsidRuleSearchOrder, OsidContainableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
RecurringEventSearchOrderRecord	getRecurringEventSearchOrderRecord(Type recurringEventRecordType) Gets the recurring event search order record corresponding to the given event 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

Methods inherited from interface org.osid.OsidContainableSearchOrder

orderBySequestered

Method Detail

getRecurringEventSearchOrderRecord

RecurringEventSearchOrderRecord getRecurringEventSearchOrderRecord(Type recurringEventRecordType)
                                                                   throws OperationFailedException

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

Parameters:

recurringEventRecordType - a recurring event record type

Returns:

the recurring event search order record

Throws:

NullArgumentException - recurringEventRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(recurringEventRecordType) is false

Compliance:

mandatory - This method must be implemented.