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

An interface for specifying the ordering of search results.

MethodgetCyclicEventSearchOrderRecord
Description

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

Parametersosid.type.TypecyclicEventRecordTypea cyclic event record type
Returnosid.calendaring.cycle.records.CyclicEventSearchOrderRecordthe cyclic event search order record
ErrorsNULL_ARGUMENT cyclicEventRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(cyclicEventRecordType) is false
CompliancemandatoryThis method must be implemented.