Interface ScheduleSlotSearchOrder

All Superinterfaces:

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

public interface ScheduleSlotSearchOrder
extends OsidObjectSearchOrder, OsidContainableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
ScheduleSlotSearchOrderRecord	getScheduleSlotSearchOrderRecord(Type scheduleSlotRecordType)	Gets the schedule slot search order record corresponding to the given schedule record Type .Multiple retrievals return the same underlying object.
void	orderByDuration(SearchOrderStyle style)	Specified a preference for ordering results by the duration.
void	orderByFixedInterval(SearchOrderStyle style)	Specified a preference for ordering results by the fixed interval.
void	orderByWeekdayStart(SearchOrderStyle style)	Specified a preference for ordering results by the starting weekday.
void	orderByWeekdayTime(SearchOrderStyle style)	Specified a preference for ordering results by the weekday time.
void	orderByWeeklyInterval(SearchOrderStyle style)	Specified a preference for ordering results by the weekly interval.
void	orderByWeekOfMonth(SearchOrderStyle style)	Specified a preference for ordering results by the week of the month.

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 OsidContainableSearchOrder

orderBySequestered

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

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

orderByWeekdayStart

void orderByWeekdayStart(SearchOrderStyle style)

Specified a preference for ordering results by the starting weekday.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByWeeklyInterval

void orderByWeeklyInterval(SearchOrderStyle style)

Specified a preference for ordering results by the weekly interval.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByWeekOfMonth

void orderByWeekOfMonth(SearchOrderStyle style)

Specified a preference for ordering results by the week of the month.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByWeekdayTime

void orderByWeekdayTime(SearchOrderStyle style)

Specified a preference for ordering results by the weekday time.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByFixedInterval

void orderByFixedInterval(SearchOrderStyle style)

Specified a preference for ordering results by the fixed interval.

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 duration.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getScheduleSlotSearchOrderRecord

ScheduleSlotSearchOrderRecord getScheduleSlotSearchOrderRecord(Type scheduleSlotRecordType)
                                                        throws OperationFailedException

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

Parameters:

scheduleSlotRecordType - a schedule slot record type

Returns:

the schedule slot search order record

Throws:

NullArgumentException - scheduleSlotRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(scheduleSlotRecordType) is false

Compliance:

mandatory - This method must be implemented.