org.osid

Interface OsidCompendiumSearchOrder

All Superinterfaces:

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

All Known Subinterfaces:

StatisticSearchOrder, SummarySearchOrder

public interface OsidCompendiumSearchOrder
extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
void	orderByEndDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the end date.
void	orderByExtrapolated(SearchOrderStyle style) Specifies a preference for ordering the result set by extrapolated results.
void	orderByInterpolated(SearchOrderStyle style) Specifies a preference for ordering the result set by interpolated results.
void	orderByStartDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the start date.

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

orderByStartDate

void orderByStartDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by the start date.

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByEndDate

void orderByEndDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by the end date.

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByInterpolated

void orderByInterpolated(SearchOrderStyle style)

Specifies a preference for ordering the result set by interpolated results.

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByExtrapolated

void orderByExtrapolated(SearchOrderStyle style)

Specifies a preference for ordering the result set by extrapolated results.

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.