OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.RecurringEventForm
Implementsosid.OsidRuleForm
osid.OsidContainableForm
Implemented Byosid.calendaring.batch.RecurringEventBatchForm
Used Byosid.calendaring.RecurringEventAdminSession
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.

MethodgetSponsorsMetadata
Description

Gets the metadata for the sponsors.

Returnosid.Metadata metadata for the sponsor
Compliancemandatory This method must be implemented.
MethodsetSponsors
Description

Sets the sponsors.

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

Clears the sponsors.

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

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

Parametersosid.type.TyperecurringEventRecordType the recurring event record type
Returnosid.calendaring.records.RecurringEventFormRecord the recurring event form record
ErrorsNULL_ARGUMENT recurringEventRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(recurringEventRecordType) is false
Compliancemandatory This method must be implemented.