OSID Logo
OSID Specifications
calendaring cycle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.cycle.CyclicTimePeriodForm
Implementsosid.OsidObjectForm
Description

This is the form for creating and updating CyclicTimePeriods. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the CyclicTimePeriodAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetCyclicTimePeriodFormRecord
Description

Gets the CyclicTimePeriodFormRecord corresponding to the given cyclic time period record Type.

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