org.osid.calendaring

Interface ScheduleSearchOrder

All Superinterfaces:

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

public interface ScheduleSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
LocationSearchOrder	getLocationSearchOrder() Gets the search order for a location.
ScheduleSearchOrderRecord	getScheduleSearchOrderRecord(Type scheduleRecordType) Gets the schedule search order record corresponding to the given schedule record Type.
ScheduleSlotSearchOrder	getScheduleSlotSearchOrder() Gets the search order for the schedule slot.
TimePeriodSearchOrder	getTimePeriodSearchOrder() Gets the search order for the time period.
void	orderByLimit(SearchOrderStyle style) Specified a preference for ordering results by the occurrence limit.
void	orderByLocation(SearchOrderStyle style) Specified a preference for ordering results by the location.
void	orderByLocationDescription(SearchOrderStyle style) Specified a preference for ordering results by the location description.
void	orderByScheduleEnd(SearchOrderStyle style) Specified a preference for ordering results by the schedule end.
void	orderByScheduleSlot(SearchOrderStyle style) Specified a preference for ordering results by the schedule slot.
void	orderByScheduleStart(SearchOrderStyle style) Specified a preference for ordering results by the schedule start.
void	orderByTimePeriod(SearchOrderStyle style) Specified a preference for ordering results by the time period.
void	orderByTotalDuration(SearchOrderStyle style) Specified a preference for ordering results by the schedule duration.
boolean	supportsLocationSearchOrder() Tests if a LocationSearchOrder is available.
boolean	supportsScheduleSlotSearchOrder() Tests if a ScheduleSlotSearchOrder is available.
boolean	supportsTimePeriodSearchOrder() Tests if a TimePeriodSearchOrder is available.

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

orderByScheduleSlot

void orderByScheduleSlot(SearchOrderStyle style)

Specified a preference for ordering results by the schedule slot.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsScheduleSlotSearchOrder

boolean supportsScheduleSlotSearchOrder()

Tests if a ScheduleSlotSearchOrder is available.

Returns:

true if a schedule slot search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getScheduleSlotSearchOrder

ScheduleSlotSearchOrder getScheduleSlotSearchOrder()

Gets the search order for the schedule slot.

Returns:

the schdeule slot search order

Throws:

UnimplementedException - supportsScheduleSlotSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsScheduleSlotSearchOrder() is true.

orderByTimePeriod

void orderByTimePeriod(SearchOrderStyle style)

Specified a preference for ordering results by the time period.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsTimePeriodSearchOrder

boolean supportsTimePeriodSearchOrder()

Tests if a TimePeriodSearchOrder is available.

Returns:

true if a time period search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTimePeriodSearchOrder

TimePeriodSearchOrder getTimePeriodSearchOrder()

Gets the search order for the time period.

Returns:

the time period search order

Throws:

UnimplementedException - supportsTimePeriodSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsTimePeriodSearchOrder() is true.

orderByScheduleStart

void orderByScheduleStart(SearchOrderStyle style)

Specified a preference for ordering results by the schedule start.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByScheduleEnd

void orderByScheduleEnd(SearchOrderStyle style)

Specified a preference for ordering results by the schedule end.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByTotalDuration

void orderByTotalDuration(SearchOrderStyle style)

Specified a preference for ordering results by the schedule duration.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByLimit

void orderByLimit(SearchOrderStyle style)

Specified a preference for ordering results by the occurrence limit.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByLocationDescription

void orderByLocationDescription(SearchOrderStyle style)

Specified a preference for ordering results by the location description.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByLocation

void orderByLocation(SearchOrderStyle style)

Specified a preference for ordering results by the location.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsLocationSearchOrder

boolean supportsLocationSearchOrder()

Tests if a LocationSearchOrder is available.

Returns:

true if a location search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLocationSearchOrder

LocationSearchOrder getLocationSearchOrder()

Gets the search order for a location.

Returns:

the location search order

Throws:

UnimplementedException - supportsLocationSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsLocationSearchOrder() is true.

getScheduleSearchOrderRecord

ScheduleSearchOrderRecord getScheduleSearchOrderRecord(Type scheduleRecordType)
                                                       throws OperationFailedException

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

Parameters:

scheduleRecordType - a schedule record type

Returns:

the schedule search order record

Throws:

NullArgumentException - scheduleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(scheduleRecordType) is false

Compliance:

mandatory - This method must be implemented.