OSID Logo
OSID Specifications
calendaring cycle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.cycle.CyclicTimePeriodSearchOrder
Implementsosid.OsidObjectSearchOrder
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.TypecyclicTimePeriodRecordTypea cyclic time period record type
Returnosid.calendaring.cycle.records.CyclicTimePeriodSearchOrderRecordthe cyclic time period search order record
ErrorsNULL_ARGUMENT cyclicTimePeriodRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(cyclicTimePeriodRecordType) is false
CompliancemandatoryThis method must be implemented.