OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.RecurringEventForm
Implementsosid.OsidRuleForm
osid.OsidContainableForm
Description

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

MethodgetSponsorMetadata
Description

Gets the metadata for a sponsor.

Returnosid.Metadatametadata for the sponsor
CompliancemandatoryThis method must be implemented.
MethodsetSponsors
Description

Sets the sponsors.

Parametersosid.id.Id[]sponsorIdsthe new sponsor
ErrorsINVALID_ARGUMENT sponsorIds is invalid
NO_ACCESS sponsorIds cannot be modified
NULL_ARGUMENT sponsorIds is null
CompliancemandatoryThis method must be implemented.
MethodclearSponsors
Description

Clears the sponsors.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetRecurringEventFormRecord
Description

Gets the RecurringEventFormRecord corresponding to the given recurring event record Type.

Parametersosid.type.TyperecurringEventRecordTypethe recurring event record type
Returnosid.calendaring.records.RecurringEventFormRecordthe recurring event form record
ErrorsNULL_ARGUMENT recurringEventRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(recurringEventRecordType) is false
CompliancemandatoryThis method must be implemented.