OSID - osid.OsidEnablerForm Service Interface Definition

Interface	osid.OsidEnablerForm
Implements	`osid.OsidRuleForm`
Implements	`osid.OsidTemporalForm`
Implemented By	`osid.repository.rules.CompositionEnablerForm`
	`osid.assessment.authoring.SequenceRuleEnablerForm`
	`osid.configuration.rules.ValueEnablerForm`
	`osid.configuration.rules.ParameterProcessorEnablerForm`
	`osid.profile.rules.ProfileEntryEnablerForm`
	`osid.bidding.rules.AuctionConstrainerEnablerForm`
	`osid.bidding.rules.AuctionProcessorEnablerForm`
	`osid.bidding.rules.BidEnablerForm`
	`osid.cataloging.rules.CatalogEnablerForm`
	`osid.contact.rules.ContactEnablerForm`
	`osid.voting.rules.RaceConstrainerEnablerForm`
	`osid.voting.rules.RaceProcessorEnablerForm`
	`osid.voting.rules.BallotConstrainerEnablerForm`
	`osid.voting.rules.VoteEnablerForm`
	`osid.subscription.rules.DispatchEnablerForm`
	`osid.subscription.rules.DispatchConstrainerEnablerForm`
	`osid.subscription.rules.DispatchProcessorEnablerForm`
	`osid.subscription.rules.SubscriptionEnablerForm`
	`osid.hold.rules.IssueEnablerForm`
	`osid.hold.rules.IssueConstrainerEnablerForm`
	`osid.hold.rules.IssueProcessorEnablerForm`
	`osid.hold.rules.HoldEnablerForm`
	`osid.OsidOperatorForm`
	`osid.OsidEffectuatorForm`
	`osid.OsidRuleApplicatorForm`
	`osid.control.rules.DeviceEnablerForm`
	`osid.control.rules.InputEnablerForm`
	`osid.control.rules.TriggerEnablerForm`
	`osid.control.rules.ActionEnablerForm`
	`osid.resource.demographic.DemographicEnablerForm`
	`osid.calendaring.rules.RecurringEventEnablerForm`
	`osid.calendaring.rules.OffsetEventEnablerForm`
	`osid.calendaring.rules.SupersedingEventEnablerForm`
	`osid.calendaring.rules.CommitmentEnablerForm`
	`osid.workflow.rules.ProcessEnablerForm`
	`osid.workflow.rules.ProcessConstrainerEnablerForm`
	`osid.workflow.rules.ProcessProcessorEnablerForm`
	`osid.workflow.rules.StepEnablerForm`
	`osid.workflow.rules.StepConstrainerEnablerForm`
	`osid.workflow.rules.StepProcessorEnablerForm`
	`osid.topology.rules.EdgeEnablerForm`
	`osid.course.requisite.RequisiteForm`
	`osid.offering.rules.CanonicalUnitEnablerForm`
	`osid.offering.rules.CanonicalUnitProcessorEnablerForm`
	`osid.offering.rules.OfferingConstrainerEnablerForm`
	`osid.ordering.rules.PriceEnablerForm`
	`osid.inquiry.rules.AuditEnablerForm`
	`osid.inquiry.rules.AuditConstrainerEnablerForm`
	`osid.inquiry.rules.AuditProcessorEnablerForm`
	`osid.inquiry.rules.InquiryEnablerForm`
	`osid.relationship.rules.RelationshipEnablerForm`
	`osid.provisioning.rules.BrokerEnablerForm`
	`osid.provisioning.rules.BrokerConstrainerEnablerForm`
	`osid.provisioning.rules.BrokerProcessorEnablerForm`
	`osid.provisioning.rules.QueueEnablerForm`
	`osid.provisioning.rules.QueueConstrainerEnablerForm`
	`osid.provisioning.rules.QueueProcessorEnablerForm`
	`osid.provisioning.rules.PoolEnablerForm`
	`osid.provisioning.rules.PoolConstrainerEnablerForm`
	`osid.provisioning.rules.PoolProcessorEnablerForm`
	`osid.provisioning.rules.ProvisionableEnablerForm`
	`osid.provisioning.rules.ProvisionEnablerForm`
	`osid.tracking.rules.QueueEnablerForm`
	`osid.tracking.rules.QueueConstrainerEnablerForm`
`osid.tracking.rules.QueueProcessorEnablerForm`
`osid.resourcing.rules.AvailabilityEnablerForm`
`osid.resourcing.rules.CommissionEnablerForm`
`osid.resourcing.rules.JobConstrainerEnablerForm`
`osid.resourcing.rules.JobProcessorEnablerForm`
`osid.mapping.path.rules.SpeedZoneEnablerForm`
`osid.mapping.path.rules.SignalEnablerForm`
`osid.mapping.path.rules.ObstacleEnablerForm`
Description	This form is used to create and update enablers.
Method	getRequirementMetadata
Description	Gets the metadata for the requirement flag.
Return	`osid.Metadata`		metadata for the requirement flag
Compliance	`mandatory`		This method must be implemented.
Method	setRequirement
Description	Sets the requirement flag.
Parameters	`boolean`	`requirement`	the new requirement flag
Errors	INVALID_ARGUMENT		`requirement` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequirement
Description	Removes the requirement flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleMetadata
Description	Gets the metadata for an associated schedule.
Return	`osid.Metadata`		metadata for the schedule
Compliance	`mandatory`		This method must be implemented.
Method	setSchedule
Description	Sets a schedule.
Parameters	`osid.id.Id`	`scheduleId`	the new schedule
Errors	INVALID_ARGUMENT		`scheduleId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`scheduleId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSchedule
Description	Removes the schedule.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getEventMetadata
Description	Gets the metadata for an associated event.
Return	`osid.Metadata`		metadata for the event
Compliance	`mandatory`		This method must be implemented.
Method	setEvent
Description	Sets an event.
Parameters	`osid.id.Id`	`eventId`	the new event
Errors	INVALID_ARGUMENT		`eventId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`eventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEvent
Description	Removes the event.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventMetadata
Description	Gets the metadata for the cyclic event.
Return	`osid.Metadata`		metadata for the cyclic event
Compliance	`mandatory`		This method must be implemented.
Method	setCyclicEvent
Description	Sets the cyclic event.
Parameters	`osid.id.Id`	`cyclicEventId`	the new cyclic event
Errors	INVALID_ARGUMENT		`cyclicEventId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`cyclicEventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCyclicEvent
Description	Removes the cyclic event.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodPeriodMetadata
Description	Gets the metadata for the time period.
Return	`osid.Metadata`		metadata for the time period
Compliance	`mandatory`		This method must be implemented.
Method	setTimePeriod
Description	Sets the time period.
Parameters	`osid.id.Id`	`timePeriodId`	the new time period
Errors	INVALID_ARGUMENT		`timePeriodId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`timePeriodId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimePeriod
Description	Removes the time period.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicTimePeriodPeriodMetadata
Description	Gets the metadata for the cyclic time period.
Return	`osid.Metadata`		metadata for the cyclic time period
Compliance	`mandatory`		This method must be implemented.
Method	setCyclicTimePeriod
Description	Sets the cyclic time period.
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	the new cyclic time period
Errors	INVALID_ARGUMENT		`cyclicTimePeriodId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`cyclicTimePeriodId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCyclicTimePeriod
Description	Removes the cyclic time period.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.