OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.ScheduleForm
Implementsosid.OsidObjectForm
Description

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

MethodgetScheduleSlotMetadata
Description

Gets the metadata for the schedule slot.

Returnosid.Metadatametadata for the schedule slot
CompliancemandatoryThis method must be implemented.
MethodsetScheduleSlot
Description

Sets the schedule slot.

Parametersosid.id.IdscheduleSlotIdthe new schedule slot Id
ErrorsINVALID_ARGUMENT scheduleSlotId is invalid
NO_ACCESS scheduleSlotId cannot be modified
NULL_ARGUMENT scheduleSlotId is null
CompliancemandatoryThis method must be implemented.
MethodclearScheduleSlot
Description

Clears the schedule slot.

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

Gets the metadata for the time period.

Returnosid.Metadatametadata for the time period
CompliancemandatoryThis method must be implemented.
MethodsetTimePeriod
Description

Sets the time period.

Parametersosid.id.IdtimePeriodIdthe new time period Id
ErrorsINVALID_ARGUMENT timePeriodId is invalid
NO_ACCESS timePeriodId cannot be modified
NULL_ARGUMENT timePeriodId is null
CompliancemandatoryThis method must be implemented.
MethodclearTimePeriod
Description

Clears the time period.

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

Gets the metadata for the schedule start date.

Returnosid.Metadatametadata for the schedule start
CompliancemandatoryThis method must be implemented.
MethodsetScheduleStart
Description

Sets the schedule start date. This may be set in lieu of a time period to set a specific date range.

Parametersosid.calendaring.DateTimestartthe new start date
ErrorsINVALID_ARGUMENT start is invalid
NO_ACCESS start cannot be modified
NULL_ARGUMENT start is null
CompliancemandatoryThis method must be implemented.
MethodclearScheduleStart
Description

Clears the schedule start.

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

Gets the metadata for the schedule end date.

Returnosid.Metadatametadata for the schedule end
CompliancemandatoryThis method must be implemented.
MethodsetScheduleEnd
Description

Sets the schedule end date. This may be set in lieu of a time period to set a specific date range.

Parametersosid.calendaring.DateTimestartthe new end date
ErrorsINVALID_ARGUMENT end is invalid
NO_ACCESS end cannot be modified
NULL_ARGUMENT end is null
CompliancemandatoryThis method must be implemented.
MethodclearScheduleEnd
Description

Clears the schedule end.

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

Gets the metadata for the recurrence limit.

Returnosid.Metadatametadata for the limit
CompliancemandatoryThis method must be implemented.
MethodsetLimit
Description

Sets the limit on the recurrences of a schedule.

Parameterscardinallimitthe new limit
ErrorsINVALID_ARGUMENT limit is invalid
NO_ACCESS limit cannot be modified
CompliancemandatoryThis method must be implemented.
MethodclearLimit
Description

Clears the limit.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
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.
MethodgetScheduleFormRecord
Description

Gets the ScheduleFormRecord corresponding to the given schedule record Type.

Parametersosid.type.TypescheduleRecordTypethe schedule record type
Returnosid.calendaring.records.ScheduleFormRecordthe schedule form record
ErrorsNULL_ARGUMENT scheduleRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(scheduleRecordType) is false
CompliancemandatoryThis method must be implemented.