org.osid.calendaring.cycle

Interface CyclicTimePeriodSearchOrder

All Superinterfaces:

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

public interface CyclicTimePeriodSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CyclicTimePeriodSearchOrderRecord	getCyclicTimePeriodSearchOrderRecord(Type cyclicTimePeriodRecordType) Gets the cyclic time period search order record corresponding to the given cyclic time period 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

getCyclicTimePeriodSearchOrderRecord

CyclicTimePeriodSearchOrderRecord getCyclicTimePeriodSearchOrderRecord(Type cyclicTimePeriodRecordType)
                                                                       throws OperationFailedException

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

Parameters:

cyclicTimePeriodRecordType - a cyclic time period record type

Returns:

the cyclic time period search order record

Throws:

NullArgumentException - cyclicTimePeriodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cyclicTimePeriodRecordType) is false

Compliance:

mandatory - This method must be implemented.