org.osid.calendaring

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

Methods

Modifier and Type	Method and Description
ScheduleSlotSearchOrderRecord	getScheduleSlotSearchOrderRecord(Type scheduleSlotRecordType) Gets the schedule slot search order record corresponding to the given schedule record Type.
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 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

Methods inherited from interface org.osid.OsidContainableSearchOrder

orderBySequestered

Method Detail

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.