OSID Logo
OSID Specifications
calendaring cycle package
Version 3.1.0
Interfaceosid.calendaring.cycle.CyclicTimePeriodSearchOrder
Implementsosid.OsidObjectSearchOrder
Used Byosid.OsidEnablerSearchOrder
osid.calendaring.cycle.CyclicTimePeriodSearchSession
osid.calendaring.cycle.CyclicTimePeriodSmartCalendarSession
Description

An interface for specifying the ordering of search results.

MethodgetCyclicTimePeriodSearchOrderRecord
Description

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

Parametersosid.type.TypecyclicTimePeriodRecordType a cyclic time period record type
Returnosid.calendaring.cycle.records.CyclicTimePeriodSearchOrderRecord the cyclic time period search order record
ErrorsNULL_ARGUMENT cyclicTimePeriodRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(cyclicTimePeriodRecordType) is false
Compliancemandatory This method must be implemented.