org.osid.calendaring

Interface TimePeriodSearchOrder

All Superinterfaces:

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

public interface TimePeriodSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
TimePeriodSearchOrderRecord	getTimePeriodSearchOrderRecord(Type timePeriodRecordType) Gets the time period search order record corresponding to the given time period record Type.
void	orderByDuration(SearchOrderStyle style) Specified a preference for ordering results by the time period duration.
void	orderByEnd(SearchOrderStyle style) Specified a preference for ordering results by the end time.
void	orderByStart(SearchOrderStyle style) Specified a preference for ordering results by the start time.

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

orderByStart

void orderByStart(SearchOrderStyle style)

Specified a preference for ordering results by the start time.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByEnd

void orderByEnd(SearchOrderStyle style)

Specified a preference for ordering results by the end time.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDuration

void orderByDuration(SearchOrderStyle style)

Specified a preference for ordering results by the time period duration.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getTimePeriodSearchOrderRecord

TimePeriodSearchOrderRecord getTimePeriodSearchOrderRecord(Type timePeriodRecordType)
                                                           throws OperationFailedException

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

Parameters:

timePeriodRecordType - a time period record type

Returns:

the time period search order record

Throws:

NullArgumentException - timePeriodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(timePeriodRecordType) is false

Compliance:

mandatory - This method must be implemented.