org.osid.calendaring.cycle

Interface CyclicEventSearchOrder

All Superinterfaces:

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

public interface CyclicEventSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CyclicEventSearchOrderRecord	getCyclicEventSearchOrderRecord(Type cyclicEventRecordType) Gets the cyclic event search order record corresponding to the given cyclic event record Type.

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

Method Detail

getCyclicEventSearchOrderRecord

CyclicEventSearchOrderRecord getCyclicEventSearchOrderRecord(Type cyclicEventRecordType)
                                                             throws OperationFailedException

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

Parameters:

cyclicEventRecordType - a cyclic event record type

Returns:

the cyclic event search order record

Throws:

NullArgumentException - cyclicEventRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cyclicEventRecordType) is false

Compliance:

mandatory - This method must be implemented.