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

Modifier and Type	Method	Description
TimePeriodSearchOrderRecord	getTimePeriodSearchOrderRecord(Type timePeriodRecordType)	Gets the time period search order record corresponding to the given time period record Type .Multiple retrievals return the same underlying object.
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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Method Details

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.