OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.OffsetEventForm
Implementsosid.OsidRuleForm
Description

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

MethodgetFixedStartTimeMetadata
Description

Gets the metadata for the fixed start time.

Returnosid.Metadatametadata for the fixed start time
CompliancemandatoryThis method must be implemented.
MethodsetFixedStartTime
Description

Sets the fixed start time.

Parametersosid.calendaring.DateTimedatethe fixed start time
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS date cannot be modified
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearFixedStartTime
Description

Clears the fixed start time.

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

Gets the metadata for the starting reference event.

Returnosid.Metadatametadata for the starting reference event
CompliancemandatoryThis method must be implemented.
MethodsetStartReferenceEvent
Description

Sets the fixed start time.

Parametersosid.id.IdeventIdthe start reference event Id
ErrorsINVALID_ARGUMENT eventId is invalid
NO_ACCESS eventId cannot be modified
NULL_ARGUMENT eventId is null
CompliancemandatoryThis method must be implemented.
MethodclearStartReferenceEvent
Description

Clears the start reference event.

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

Gets the metadata for the fixed start offset.

Returnosid.Metadatametadata for the fixed start offset
CompliancemandatoryThis method must be implemented.
MethodsetFixedStartOffset
Description

Sets the fixed start offset.

Parametersosid.calendaring.Durationoffsetthe fixed offset
ErrorsINVALID_ARGUMENT offset is invalid
NO_ACCESS offset cannot be modified
NULL_ARGUMENT offset is null
CompliancemandatoryThis method must be implemented.
MethodclearFixedStartOffset
Description

Clears the fixed start offset.

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

Gets the metadata for the relative weekday offset.

Returnosid.Metadatametadata for the relative weekday offset
CompliancemandatoryThis method must be implemented.
MethodsetRelativeWeekdayStartOffset
Description

Sets the relative weekday offset as the nth weekday from the relative event.

Parametersintegeroffsetthe week offset
ErrorsINVALID_ARGUMENT offset is invalid
NO_ACCESS offset cannot be modified
CompliancemandatoryThis method must be implemented.
MethodclearRelativeWeekdayStartOffset
Description

Clears the relative weekday offset.

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

Gets the metadata for the relative weekday.

Returnosid.Metadatametadata for the relative weekday
CompliancemandatoryThis method must be implemented.
MethodsetRelativeStartWeekday
Description

Sets the relative weekday.

Parameterscardinalweekdaythe weekday
ErrorsINVALID_ARGUMENT weekday is invalid
NO_ACCESS weekday cannot be modified
CompliancemandatoryThis method must be implemented.
MethodclearRelativeStartWeekday
Description

Clears the relative start weekday.

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

Gets the metadata for the fixed duration.

Returnosid.Metadatametadata for the fixed duration
CompliancemandatoryThis method must be implemented.
MethodsetFixedDuration
Description

Sets the fixed duration.

Parametersosid.calendaring.Durationdurationthe fixed duration
ErrorsINVALID_ARGUMENT duration is invalid
NO_ACCESS duration cannot be modified
NULL_ARGUMENT duration is null
CompliancemandatoryThis method must be implemented.
MethodclearFixedDuration
Description

Clears the fixed duration.

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

Gets the metadata for the ending reference event.

Returnosid.Metadatametadata for the ending reference event
CompliancemandatoryThis method must be implemented.
MethodsetEndReferenceEvent
Description

Sets the fixed end time.

Parametersosid.id.IdeventIdthe end reference event Id
ErrorsINVALID_ARGUMENT eventId is invalid
NO_ACCESS eventId cannot be modified
NULL_ARGUMENT eventId is null
CompliancemandatoryThis method must be implemented.
MethodclearEndReferenceEvent
Description

Clears the ending reference event.

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

Gets the metadata for the fixed end offset.

Returnosid.Metadatametadata for the fixed end offset
CompliancemandatoryThis method must be implemented.
MethodsetFixedEndOffset
Description

Sets the fixed end offset.

Parametersosid.calendaring.Durationoffsetthe fixed offset
ErrorsINVALID_ARGUMENT offset is invalid
NO_ACCESS offset cannot be modified
NULL_ARGUMENT offset is null
CompliancemandatoryThis method must be implemented.
MethodclearFixedEndOffset
Description

Clears the fixed end offset.

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

Gets the metadata for the relative weekday offset.

Returnosid.Metadatametadata for the relative weekday offset
CompliancemandatoryThis method must be implemented.
MethodsetRelativeWeekdayEndOffset
Description

Sets the relative weekday offset as the nth weekday from the relative event.

Parametersintegeroffsetthe week offset
ErrorsINVALID_ARGUMENT offset is invalid
NO_ACCESS offset cannot be modified
CompliancemandatoryThis method must be implemented.
MethodclearRelativeWeekdayEndOffset
Description

Clears the relative weekday offset.

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

Gets the metadata for the relative weekday.

Returnosid.Metadatametadata for the relative weekday
CompliancemandatoryThis method must be implemented.
MethodsetRelativeEndWeekday
Description

Sets the relative weekday.

Parameterscardinalweekdaythe weekday
ErrorsINVALID_ARGUMENT weekday is invalid
NO_ACCESS weekday cannot be modified
CompliancemandatoryThis method must be implemented.
MethodclearRelativeEndWeekday
Description

Clears the relative end weekday.

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

Gets the OffsetEventFormRecord corresponding to the given schedule record Type.

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