OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.TimePeriodSearchOrder
Implementsosid.OsidObjectSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByStart
Description

Specified a preference for ordering results by the start time.

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

Specified a preference for ordering results by the end time.

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

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

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

Parametersosid.type.TypetimePeriodRecordTypea time period record type
Returnosid.calendaring.records.TimePeriodSearchOrderRecordthe time period search order record
ErrorsNULL_ARGUMENT timePeriodRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(timePeriodRecordType) is false
CompliancemandatoryThis method must be implemented.