OSID Logo
OSID Specifications
calendaring cycle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.cycle.CyclicEvent
Implementsosid.OsidObject
Description

An CyclicEvent represents canonical event.

MethodgetCyclicEventRecord
Description

Gets the cyclic event record corresponding to the given CyclicEvent record Type. This method is used to retrieve an object implementing the requested record. The cyclicEventRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(cyclicEventRecordType) is true .

Parametersosid.type.TypecyclicEventRecordTypethe type of the record to retrieve
Returnosid.calendaring.cycle.records.CyclicEventRecordthe cyclic event record
ErrorsNULL_ARGUMENT cyclicEventRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(cyclicEventRecordType) is false
CompliancemandatoryThis method must be implemented.