OSID Logo
OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
Interfaceosid.OsidEnablerForm
Implementsosid.OsidRuleForm
osid.OsidTemporalForm
Description

This form is used to create and update enablers.

MethodgetScheduleMetadata
Description

Gets the metadata for an associated schedule.

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

Sets a schedule.

Parametersosid.id.IdscheduleIdthe new schedule
ErrorsINVALID_ARGUMENT scheduleId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT scheduleId is null
CompliancemandatoryThis method must be implemented.
MethodclearSchedule
Description

Removes the schedule.

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

Gets the metadata for an associated event.

Returnosid.Metadatametadata for the event
CompliancemandatoryThis method must be implemented.
MethodsetEvent
Description

Sets an event.

Parametersosid.id.IdeventIdthe new event
ErrorsINVALID_ARGUMENT eventId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT eventId is null
CompliancemandatoryThis method must be implemented.
MethodclearEvent
Description

Removes the event.

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

Gets the metadata for the cyclic event.

Returnosid.Metadatametadata for the cyclic event
CompliancemandatoryThis method must be implemented.
MethodsetCyclicEvent
Description

Sets the cyclic event.

Parametersosid.id.IdcyclicEventIdthe new cyclic event
ErrorsINVALID_ARGUMENT cyclicEventId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT cyclicEventId is null
CompliancemandatoryThis method must be implemented.
MethodclearCyclicEvent
Description

Removes the cyclic event.

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

Gets the metadata for an associated demographic.

Returnosid.Metadatametadata for the resource.
CompliancemandatoryThis method must be implemented.
MethodsetDemographic
Description

Sets a resource demographic.

Parametersosid.id.IdresourceIdthe new resource
ErrorsINVALID_ARGUMENT resourceId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearDemographic
Description

Removes the resource demographic.

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