OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.EventForm
Implementsosid.OsidObjectForm
osid.OsidTemporalForm
osid.OsidContainableForm
Description

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

MethodgetLocationDescriptionMetadata
Description

Gets the metadata for a location description.

Returnosid.Metadatametadata for the location description
CompliancemandatoryThis method must be implemented.
MethodsetLocationDescription
Description

Sets the location description.

Parametersstringlocationthe new location description
ErrorsINVALID_ARGUMENT location is invalid
NO_ACCESS location cannot be modified
NULL_ARGUMENT location is null
CompliancemandatoryThis method must be implemented.
MethodclearLocationDescription
Description

Clears the location description.

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

Gets the metadata for a location.

Returnosid.Metadatametadata for the location
CompliancemandatoryThis method must be implemented.
MethodsetLocation
Description

Sets the location.

Parametersosid.id.IdlocationIdthe new location
ErrorsINVALID_ARGUMENT locationId is invalid
NO_ACCESS locationId cannot be modified
NULL_ARGUMENT locationId is null
CompliancemandatoryThis method must be implemented.
MethodclearLocation
Description

Clears the location.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
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.
MethodgetEventFormRecord
Description

Gets the EventFormRecord corresponding to the given event record Type.

Parametersosid.type.TypeeventRecordTypethe event record type
Returnosid.calendaring.records.EventFormRecordthe event form record
ErrorsNULL_ARGUMENT eventRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(eventRecordType) is false
CompliancemandatoryThis method must be implemented.