OSID Logo
OSID Specifications
calendaring cycle package
Version 3.1.0
Interfaceosid.calendaring.cycle.CyclicTimePeriod
Implementsosid.OsidObject
Used Byosid.OsidEnabler
osid.OsidRuleApplicator
osid.calendaring.cycle.CyclicTimePeriodAdminSession
osid.calendaring.cycle.CyclicTimePeriodList
osid.calendaring.cycle.CyclicTimePeriodLookupSession
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.TypecyclicTimePeriodRecordType the type of the record to retrieve
Returnosid.calendaring.cycle.records.CyclicTimePeriodRecord the cyclic time period record
ErrorsNULL_ARGUMENT cyclicTimePeriodRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(cyclicTimePeriodRecordType) is false
Compliancemandatory This method must be implemented.