OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.Event
Implementsosid.OsidObject
osid.Temporal
osid.Containable
Description

An Event represents a span of time and an optional location.

MethodisImplicit
Description

Tests if this event is implicit. An implicit event is one that is generated from an offset or recurring series.

Returnboolean true if this event is implicit, false if explicitly defined
CompliancemandatoryThis method must be implemented.
MethodisInRecurringSeries
Description

Tests if this event is an implclit event part of a recurring event. If true, isImplicit() must also be true.

Returnboolean true if this event is part of a recurring series, false otherwise
CompliancemandatoryThis method must be implemented.
MethodisSupersedingEvent
Description

Tests if this event is a superseding event. If true, isImplicit() must also be true.

Returnboolean true if this event is superseding event, false otherwise
CompliancemandatoryThis method must be implemented.
MethodisOffsetEvent
Description

Tests if this event is an event calculated from an offset. If true, isImplicit() must also be true.

Returnboolean true if this event is an offset event, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDuration
Description

Gets the duration of the event.

Parametersosid.calendaring.DateTimeResolutionunitsthe units of the duration
Returnosid.calendaring.Durationthe duration
ErrorsNULL_ARGUMENT units is null
CompliancemandatoryThis method must be implemented.
MethodgetLocationDescription
Description

Gets a descriptive location.

Returnosid.locale.DisplayTextthe location
CompliancemandatoryThis method must be implemented.
MethodhasLocation
Description

Tests if a location is associated with this event.

Returnboolean true if there is an associated location, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLocationId
Description

Gets the location Id .

Returnosid.id.Ida location Id
ErrorsILLEGAL_STATE hasLocation() is false
CompliancemandatoryThis method must be implemented.
MethodgetLocation
Description

Gets the Location.

Returnosid.mapping.Locationa location
ErrorsILLEGAL_STATE hasLocation() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasSponsors
Description

Tests if a sponsor is associated with this event.

Returnboolean true if there is an associated sponsor. false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSponsorIds
Description

Gets the Id of the event sponsors.

Returnosid.id.IdListthe sponsor Ids
ErrorsILLEGAL_STATE hasSponsors() is false
CompliancemandatoryThis method must be implemented.
MethodgetSponsors
Description

Gets the Sponsors.

Returnosid.resource.ResourceListthe sponsors
ErrorsILLEGAL_STATE hasSponsors() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetEventRecord
Description

Gets the event record corresponding to the given Event record Type. This method is used to retrieve an object implementing the requested record. The eventRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(eventRecordType) is true .

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