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

A CyclicTimePeriod represents a canonical span of time.

MethodgetCyclicTimePeriodRecord
Description

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

Parametersosid.type.TypecyclicTimePeriodRecordTypethe type of the record to retrieve
Returnosid.calendaring.cycle.records.CyclicTimePeriodRecordthe cyclic time period record
ErrorsNULL_ARGUMENT cyclicTimePeriodRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(cyclicTimePeriodRecordType) is false
CompliancemandatoryThis method must be implemented.