org.osid.calendaring

Interface CalendarSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface CalendarSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CalendarSearchOrderRecord	getCalendarSearchOrderRecord(Type calendarRecordType) Gets the calendar search order record corresponding to the given calendar 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

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getCalendarSearchOrderRecord

CalendarSearchOrderRecord getCalendarSearchOrderRecord(Type calendarRecordType)
                                                       throws OperationFailedException

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

Parameters:

calendarRecordType - a calendar record type

Returns:

the calendar search order record

Throws:

NullArgumentException - calendarRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(calendarRecordType) is false

Compliance:

mandatory - This method must be implemented.