OSID - osid.OsidEnabler Service Interface Definition

Interface	osid.OsidEnabler
Implements	`osid.OsidRule`
Implements	`osid.Temporal`
Implemented By	`osid.repository.rules.CompositionEnabler`
	`osid.assessment.authoring.SequenceRuleEnabler`
	`osid.configuration.rules.ValueEnabler`
	`osid.configuration.rules.ParameterProcessorEnabler`
	`osid.profile.rules.ProfileEntryEnabler`
	`osid.bidding.rules.AuctionConstrainerEnabler`
	`osid.bidding.rules.AuctionProcessorEnabler`
	`osid.bidding.rules.BidEnabler`
	`osid.cataloging.rules.CatalogEnabler`
	`osid.contact.rules.ContactEnabler`
	`osid.voting.rules.RaceConstrainerEnabler`
	`osid.voting.rules.RaceProcessorEnabler`
	`osid.voting.rules.BallotConstrainerEnabler`
	`osid.voting.rules.VoteEnabler`
	`osid.subscription.rules.DispatchEnabler`
	`osid.subscription.rules.DispatchConstrainerEnabler`
	`osid.subscription.rules.DispatchProcessorEnabler`
	`osid.subscription.rules.SubscriptionEnabler`
	`osid.hold.rules.IssueEnabler`
	`osid.hold.rules.IssueConstrainerEnabler`
	`osid.hold.rules.IssueProcessorEnabler`
	`osid.hold.rules.HoldEnabler`
	`osid.OsidOperator`
	`osid.OsidEffectuator`
	`osid.OsidRuleApplicator`
	`osid.control.rules.DeviceEnabler`
	`osid.control.rules.InputEnabler`
	`osid.control.rules.TriggerEnabler`
	`osid.control.rules.ActionEnabler`
	`osid.resource.demographic.DemographicEnabler`
	`osid.calendaring.rules.RecurringEventEnabler`
	`osid.calendaring.rules.OffsetEventEnabler`
	`osid.calendaring.rules.SupersedingEventEnabler`
	`osid.calendaring.rules.CommitmentEnabler`
	`osid.ontology.rules.RelevancyEnabler`
	`osid.workflow.rules.ProcessEnabler`
	`osid.workflow.rules.ProcessConstrainerEnabler`
	`osid.workflow.rules.ProcessProcessorEnabler`
	`osid.workflow.rules.StepEnabler`
	`osid.workflow.rules.StepConstrainerEnabler`
	`osid.workflow.rules.StepProcessorEnabler`
	`osid.topology.rules.EdgeEnabler`
	`osid.course.requisite.Requisite`
	`osid.offering.rules.CanonicalUnitEnabler`
	`osid.offering.rules.CanonicalUnitProcessorEnabler`
	`osid.offering.rules.OfferingConstrainerEnabler`
	`osid.ordering.rules.PriceEnabler`
	`osid.inquiry.rules.AuditEnabler`
	`osid.inquiry.rules.AuditConstrainerEnabler`
	`osid.inquiry.rules.AuditProcessorEnabler`
	`osid.inquiry.rules.InquiryEnabler`
	`osid.relationship.rules.RelationshipEnabler`
	`osid.provisioning.rules.BrokerEnabler`
	`osid.provisioning.rules.BrokerConstrainerEnabler`
	`osid.provisioning.rules.BrokerProcessorEnabler`
	`osid.provisioning.rules.QueueEnabler`
	`osid.provisioning.rules.QueueConstrainerEnabler`
	`osid.provisioning.rules.QueueProcessorEnabler`
	`osid.provisioning.rules.PoolEnabler`
	`osid.provisioning.rules.PoolConstrainerEnabler`
	`osid.provisioning.rules.PoolProcessorEnabler`
	`osid.provisioning.rules.ProvisionableEnabler`
	`osid.provisioning.rules.ProvisionEnabler`
	`osid.tracking.rules.QueueEnabler`
`osid.tracking.rules.QueueConstrainerEnabler`
`osid.tracking.rules.QueueProcessorEnabler`
`osid.resourcing.rules.AvailabilityEnabler`
`osid.resourcing.rules.CommissionEnabler`
`osid.resourcing.rules.JobConstrainerEnabler`
`osid.resourcing.rules.JobProcessorEnabler`
`osid.mapping.path.rules.SpeedZoneEnabler`
`osid.mapping.path.rules.SignalEnabler`
`osid.mapping.path.rules.ObstacleEnabler`
Description	An `OsidEnabler` is an `OsidRule` used to manage the effectiveness, enabledness, or operation of an `OsidObject`. The `OsidEnabler` itself may be active or inactive. When an `OsidEnabler` is active, any `OsidObject` to which it is applied is "on." When all `OsidEnablers` applied to an `OsidObject` are inactive, then the `OsidObject` is "off." If `isRequirement()` is `true`, then this `OsidEnabler` must be active regardless of the state of any other `OsidEnablers` mapped to the `OsidObject`. The managed `OsidObject` may have varying semantics as to what its on/off status means and in particular, which methods are used to indicate the effect of an applied `OsidEnabler`. These semantics are defined in the types of `OsidEnablers`. `Operables`: `OsidOperators` effect the operational status of the `Operable` . `Temporals`: `OsidEffectuators` may be used to extend or shorten the effectiveness of a `Temporal` such as an `OsidRelationship`. `OsidRules`: `OsidRuleApplicators` determine if the `OsidRule` is applicable in an evaluation. `OsidEnablers` are both `Operables` and `Temporals`. Ineffective `OsidEnablers` are not operational therefore not active. In other words, `isOperational()` also depends on `isEffective()`. `OsidEnablers` define several built-in dimensions to govern its operational status. effective dates: The `OsidEnabler` is operational during these dates and evaluated using a date. schedule: The `OsidEnabler` is operational when the date is occurs on the `Schedule` and the date is within the effective dates. event: The `OsidEnabler` is operational when the date occurs within the `Event` and the date is within the effective dates. `Events` may be comprised of `Schedules` and other rules making them discontinuous. cyclic event: The `OsidEnabler` is operational when the date cccurs within the `CyclicEvent` and the date is within the effective dates. `CyclicEvents` may be complex recurring events but also recur from one time period to the next, such as annually. time period: The `OsidEnabler` is operational during a `TimePeriod`. cyclic time period: The `OsidEnabler` is operational during a recurring `TimePeriod`. For example, any Spring term.
Method	isRequirement
Description	Tests if this `OsidEnabler` is a requirement. Requirements are special-case `OsidEnablers`. If `true`, the `OsidObjects` to which this `OsidEnabler` is applied become inactive when this `OsidEnabler` is inactive, regardless of the state of any other `OsidEnabler`. When this `OsidEnabler` is active, the state of the `OsidObject` is driven off of the state of the other applied `OsidEnablers`. If `false`, the `OsidObject` is active when any applied `OsidEnabler` is active including this one.
Return	`boolean`	`true` if this enabler is a requirement, `false` otherwise
Compliance	`mandatory`	This method must be implemented.
Method	isOperationalOnSchedule
Description	Tests if the operational status of the enabler is governed by a `Schedule`. If a schedule exists, it is bounded by the effective dates of this enabler.
Return	`boolean`	`true` if the enabler is operational on a schedule, `false` otherwise
Compliance	`mandatory`	This method must be implemented.
Method	getScheduleId
Description	Gets the schedule `Id`.
Return	`osid.id.Id`	the schedule `Id`
Errors	ILLEGAL_STATE	`isOperationalOnSchedule()` is `false`
Compliance	`mandatory`	This method must be implemented.
Method	getSchedule
Description	Gets the schedule.
Return	`osid.calendaring.Schedule`	the schedule
Errors	ILLEGAL_STATE	`isOperationalOnSchedule()` is `false`
Errors	OPERATION_FAILED	unable to complete request
Compliance	`mandatory`	This method must be implemented.
Method	isOperationalDuringEvent
Description	Tests if the operational status of the enabler is governed by an `Event`. The event may also be a `RecurringEvent` in which case the enabler is effective for start and end dates of each event in the series If an event exists, it is bounded by the effective dates of this enabler.
Return	`boolean`	`true` if the enabler is operational for an event, `false` otherwise
Compliance	`mandatory`	This method must be implemented.
Method	getEventId
Description	Gets the event `Id`.
Return	`osid.id.Id`	the event `Id`
Errors	ILLEGAL_STATE	`isOperationalDuringEvent()` is `false`
Compliance	`mandatory`	This method must be implemented.
Method	getEvent
Description	Gets the event.
Return	`osid.calendaring.Event`	the event
Errors	ILLEGAL_STATE	`isOperationalDuringEvent()` is `false`
Errors	OPERATION_FAILED	unable to complete request
Compliance	`mandatory`	This method must be implemented.
Method	isOperationalDuringCyclicEvent
Description	Tests if the operational status of the enabler is governed by a `CyclicEvent`.
Return	`boolean`	`true` if the enabler is governed by a cyclic event, `false` otherwise
Compliance	`mandatory`	This method must be implemented.
Method	getCyclicEventId
Description	Gets the cyclic event `Id`.
Return	`osid.id.Id`	the cyclic event `Id`
Errors	ILLEGAL_STATE	`isOperationalDuringCyclicEvent()` is `false`
Compliance	`mandatory`	This method must be implemented.
Method	getCyclicEvent
Description	Gets the cyclic event.
Return	`osid.calendaring.cycle.CyclicEvent`	the cyclic event
Errors	ILLEGAL_STATE	`isOperationalDuringCyclicEvent()` is `false`
Errors	OPERATION_FAILED	unable to complete request
Compliance	`mandatory`	This method must be implemented.
Method	isOperationalDuringTimePeriod
Description	Tests if this enabler is applied to a `TimePeriod`. A `TimePeriod` is effectively bounded by its effective dates which determine whether or not this enabler is active. For example, a rule may be active between June 1 and June 30 but applied to financial transactions pertaining to 2015Q4.
Return	`boolean`	`true` if the enabler applied to a time period, `false` otherwise
Compliance	`mandatory`	This method must be implemented.
Method	getTimePeriodId
Description	Gets the time period `Id`.
Return	`osid.id.Id`	the time period `Id`
Errors	ILLEGAL_STATE	`isOperationalDuringTimePeriod()` is `false`
Compliance	`mandatory`	This method must be implemented.
Method	getTimePeriod
Description	Gets the time period.
Return	`osid.calendaring.TimePeriod`	the time period
Errors	ILLEGAL_STATE	`isOperationalDuringTimePeriod()` is `false`
Errors	OPERATION_FAILED	unable to complete request
Compliance	`mandatory`	This method must be implemented.
Method	isOperationalDuringCyclicTimePeriod
Description	Tests if this enabler is applied to a recurring `CyclicTimePeriod`. If a cyclic time period exists, it is effectively bounded by the effective dates of this enabler that determine whether or not this enabler is active.
Return	`boolean`	`true` if the enabler is appleid to a cycic time period, `false` otherwise
Compliance	`mandatory`	This method must be implemented.
Method	getCyclicTimePeriodId
Description	Gets the cyclic time period `Id`.
Return	`osid.id.Id`	the cyclic time period `Id`
Errors	ILLEGAL_STATE	`isOperationalDuringCyclicTimePeriod()` is `false`
Compliance	`mandatory`	This method must be implemented.
Method	getCyclicTimePeriod
Description	Gets the cyclic time period.
Return	`osid.calendaring.cycle.CyclicTimePeriod`	the cyclic time period
Errors	ILLEGAL_STATE	`isOperationalDuringCyclicTimePeriod()` is `false`
Errors	OPERATION_FAILED	unable to complete request
Compliance	`mandatory`	This method must be implemented.