OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.ScheduleSlotSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidContainableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByWeekdayStart
Description

Specified a preference for ordering results by the starting weekday.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByWeeklyInterval
Description

Specified a preference for ordering results by the weekly interval.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByWeekOfMonth
Description

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByWeekdayTime
Description

Specified a preference for ordering results by the weekday time.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByFixedInterval
Description

Specified a preference for ordering results by the fixed interval.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByDuration
Description

Specified a preference for ordering results by the duration.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetScheduleSlotSearchOrderRecord
Description

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

Parametersosid.type.TypescheduleSlotRecordTypea schedule slot record type
Returnosid.calendaring.records.ScheduleSlotSearchOrderRecordthe schedule slot search order record
ErrorsNULL_ARGUMENT scheduleSlotRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(scheduleSlotRecordType) is false
CompliancemandatoryThis method must be implemented.