OSID Logo
OSID Specifications
calendaring cycle package
Version 3.1.0
Interfaceosid.calendaring.cycle.CyclicEvent
Implementsosid.OsidObject
Used Byosid.OsidEnabler
osid.calendaring.cycle.CyclicEventAdminSession
osid.calendaring.cycle.CyclicEventList
osid.calendaring.cycle.CyclicEventLookupSession
osid.checklist.mason.TodoProducer
osid.rules.check.Check
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.TypecyclicEventRecordType the type of the record to retrieve
Returnosid.calendaring.cycle.records.CyclicEventRecord the cyclic event record
ErrorsNULL_ARGUMENT cyclicEventRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(cyclicEventRecordType) is false
Compliancemandatory This method must be implemented.