OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.OffsetEvent
Implementsosid.OsidRule
Description

An OffsetEvent describes events that are relative to other events. OffsetEvents may have a fixed or rubber start date as well as a fixed or rubber end date. A rubber start and end date has a variable duration based on the starting and ending milestones. An OffsetEvent with a fixed start date and a fixed duration behaves like a normal fixed Event.

Creating an OffsetEvent produces an Event that is based on these offset rules.

MethodhasFixedStartTime
Description

Tests if this offset event is based on a fixed start time.

Returnboolean true if this offset is based on a fixed start time, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetFixedStartTime
Description

Gets the fixed start time for this event.

Returnosid.calendaring.DateTimethe fixed start time
ErrorsILLEGAL_STATE hasFixedStartIme() is false
CompliancemandatoryThis method must be implemented.
MethodgetStartReferenceEventId
Description

Gets the Event Id to which the start of this event is offset.

Returnosid.id.Idthe relative event Id
ErrorsILLEGAL_STATE hasFixedStartTime() is true
CompliancemandatoryThis method must be implemented.
MethodgetStartReferenceEvent
Description

Gets the Event to which the start of this event is offset.

Returnosid.calendaring.Eventthe relative event
ErrorsILLEGAL_STATE hasFixedStartTime() is true
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasFixedStartOffset
Description

Tests if this offset start time based on a fixed period of time.

Returnboolean true if this offset is based on a fixed period of time, false otherwise
ErrorsILLEGAL_STATE hasFixedStartTime() is true
CompliancemandatoryThis method must be implemented.
MethodgetFixedStartOffset
Description

Gets the fixed starting time offset.

Returnosid.calendaring.Durationthe offset
ErrorsILLEGAL_STATE hasFixedStartOffset() is false
CompliancemandatoryThis method must be implemented.
MethodhasRelativeWeekdayStartOffset
Description

Tests if this starting time offset is a based on a relative weekday.

Returnboolean true if this offset is based on a relative weekday, false otherwise
ErrorsILLEGAL_STATE hasFixedStartOffset() is true
CompliancemandatoryThis method must be implemented.
MethodgetRelativeWeekdayStartOffset
Description

Gets the starting offset as the nth weekday from the relative event. Zero is no offset.

Returnintegerthe offset
ErrorsILLEGAL_STATE hasRelativeWeekdayStartOffset() is false
CompliancemandatoryThis method must be implemented.
MethodgetRelativeStartWeekday
Description

Gets the starting weekday number. The weekday is based on the calendar type. On the Gregorian calendar, 0 is Sunday.

Returncardinalthe weekday number
ErrorsILLEGAL_STATE hasRelativeWeekdayStartOffset() is false
CompliancemandatoryThis method must be implemented.
MethodhasFixedDuration
Description

Tests if this offset event is based on a fixed duration.

Returnboolean true if this offset is based on a fixed duration, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetFixedDuration
Description

Gets the duration of the offset event.

Parametersosid.calendaring.DateTimeResolutionunitsthe units of the duration
Returnosid.calendaring.Durationthe duration
ErrorsILLEGAL_STATE hasFixedDuration() is false
NULL_ARGUMENT units is null
CompliancemandatoryThis method must be implemented.
MethodgetEndReferenceEventId
Description

Gets the Event Id to which the end of this event is offset.

Returnosid.id.Idthe relative event Id
ErrorsILLEGAL_STATE hasFixedDuration() is true
CompliancemandatoryThis method must be implemented.
MethodgetEndReferenceEvent
Description

Gets the Event to which the end of this event is offset.

Returnosid.calendaring.Eventthe relative event
ErrorsILLEGAL_STATE hasFixedDuration() is true
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasFixedEndOffset
Description

Tests if this offset end time based on a fixed period of time.

Returnboolean true if this offset is based on a fixed period of time, false otherwise
ErrorsILLEGAL_STATE hasFixedDuration() is true
CompliancemandatoryThis method must be implemented.
MethodgetFixedEndOffset
Description

Gets the fixed ending time offset.

Returnosid.calendaring.Durationthe offset
ErrorsILLEGAL_STATE hasFixedEndOffset() is false
CompliancemandatoryThis method must be implemented.
MethodhasRelativeWeekdayEndOffset
Description

Tests if this ending time offset is a based on a relative weekday.

Returnboolean true if this offset is based on a relative weekday, false otherwise
ErrorsILLEGAL_STATE hasFixedEndOffset() is true
CompliancemandatoryThis method must be implemented.
MethodgetRelativeWeekdayEndOffset
Description

Gets the ending offset as the nth weekday from the relative event. Zero is no offset.

Returnintegerthe offset
ErrorsILLEGAL_STATE hasRelativeWeekdayEndOffset() is false
CompliancemandatoryThis method must be implemented.
MethodgetRelativeEndWeekday
Description

Gets the ending weekday number. The weekday is based on the calendar type. On the Gregorian calendar, 0 is Sunday.

Returncardinalthe weekday number
ErrorsILLEGAL_STATE hasRelativeWeekdayEndOffset() is false
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.
MethodgetOffsetEventRecord
Description

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

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