OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.TimePeriodSearchOrder
Implementsosid.OsidObjectSearchOrder
Used Byosid.OsidEnablerSearchOrder
osid.calendaring.ScheduleSearchOrder
osid.calendaring.TimePeriodSearchSession
osid.calendaring.TimePeriodSmartCalendarSession
osid.offering.OfferingSearchOrder
osid.offering.ParticipantSearchOrder
osid.recognition.ConvocationSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByStart
Description

Specified a preference for ordering results by the start time.

Parametersosid.SearchOrderStylestyle a search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByEnd
Description

Specified a preference for ordering results by the end time.

Parametersosid.SearchOrderStylestyle a search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByDuration
Description

Specified a preference for ordering results by the time period duration.

Parametersosid.SearchOrderStylestyle a search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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.TypetimePeriodRecordType a time period record type
Returnosid.calendaring.records.TimePeriodSearchOrderRecord the time period search order record
ErrorsNULL_ARGUMENT timePeriodRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(timePeriodRecordType) is false
Compliancemandatory This method must be implemented.