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

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

MethodgetSupersededDateMetadata
Description

Gets the metadata to superseding an event within a recurring series by date.

Returnosid.Metadatametadata for a superseded date
CompliancemandatoryThis method must be implemented.
MethodsetSupersededDate
Description

Sets the superseded date.

Parametersosid.calendaring.DateTimedatethe new superseded date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS date cannot be modified
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearSupersededDate
Description

Clears the superseded date.

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

Gets the metadata to superseding an event within a recurring series by date.

Returnosid.Metadatametadata for a superseded date
CompliancemandatoryThis method must be implemented.
MethodsetSupersededEventPosition
Description

Sets the superseded position. A negative number counts from the end of the series.

Parametersintegerpositionthe new superseded position
ErrorsINVALID_ARGUMENT position is invalid
NO_ACCESS position cannot be modified
CompliancemandatoryThis method must be implemented.
MethodclearSupersededEventPosition
Description

Clears the superseded position.

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

Gets the SupersedingEventFormRecord corresponding to the given superseding event record Type.

Parametersosid.type.TypesupersedingEventRecordTypethe superseding event record type
Returnosid.calendaring.records.SupersedingEventFormRecordthe superseding event form record
ErrorsNULL_ARGUMENT supersedingEventRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(supersedingEventRecordType) is false
CompliancemandatoryThis method must be implemented.