Operable

All Known Subinterfaces:

Action, ActionEnabler, ActivityUnit, AssessmentPart, AssessmentRequirement, Auction, AuctionConstrainer, AuctionConstrainerEnabler, AuctionProcessor, AuctionProcessorEnabler, Audit, AuditEnabler, AuthorizationEnabler, AvailabilityEnabler, AwardRequirement, Ballot, BallotConstrainer, BallotConstrainerEnabler, Branch, Broker, BrokerConstrainer, BrokerConstrainerEnabler, BrokerProcessor, BrokerProcessorEnabler, CanonicalUnit, CanonicalUnitEnabler, CanonicalUnitProcessor, CanonicalUnitProcessorEnabler, CatalogEnabler, Check, CommissionEnabler, CommitmentEnabler, Composition, CompositionEnabler, ContactEnabler, Controller, Convocation, Course, CourseRequirement, CredentialRequirement, Demographic, DemographicEnabler, DeviceEnabler, Dispatch, EdgeEnabler, Function, GradebookColumnCalculation, GradeSystemTransform, HoldEnabler, InputEnabler, Inquiry, InquiryEnabler, Instruction, Job, JobConstrainer, JobConstrainerEnabler, JobProcessor, JobProcessorEnabler, LearningObjectiveRequirement, Module, Obstacle, ObstacleEnabler, OfferingConstrainer, OfferingConstrainerEnabler, OffsetEvent, OffsetEventEnabler, OsidConstrainer, OsidEnabler, OsidGovernator, OsidProcessor, OsidRule, Parameter, ParameterProcessor, ParameterProcessorEnabler, Pool, PoolConstrainer, PoolConstrainerEnabler, PoolProcessor, PoolProcessorEnabler, Price, PriceEnabler, Process, ProcessEnabler, ProfileEntryEnabler, Program, ProgramRequirement, Queue, Queue, QueueConstrainer, QueueConstrainer, QueueConstrainerEnabler, QueueConstrainerEnabler, QueueProcessor, QueueProcessor, QueueProcessorEnabler, QueueProcessorEnabler, Race, RaceConstrainer, RaceConstrainerEnabler, RaceProcessor, RaceProcessorEnabler, RecurringEvent, RecurringEventEnabler, RelationshipEnabler, RelevancyEnabler, Requisite, Rule, SequenceRule, SequenceRuleEnabler, Signal, SignalEnabler, SpeedZone, SpeedZoneEnabler, Step, StepConstrainer, StepConstrainerEnabler, StepProcessor, StepProcessorEnabler, SubscriptionEnabler, SupersedingEvent, SupersedingEventEnabler, TodoProducer, Trigger, TriggerEnabler, Value, ValueEnabler
```
public interface Operable
```
Operable is used to indicate an OsidObject performs operations. The active status indicates if the Operable is on or off. The active status is determined from the operational status and the enabling rules.

The operational status indicates the Operable is functioning. This status is not set administratively but instead refelects suitable conditions for operation.

Operables may be administratively turned on of off through the enabled and disabled administrative overrides. If there are no related OsidEnabler rules, then isEnabled() should be set to true and isDisabled() set to false for the Operable to be on and isEnabled() set to false and isDisabled() set to true for the Operable to be off. isEnabled() and isDisabled() cannot both be tru e.

If there are related OsidEnabler rules, the active status of at least one OsidEnabler results in a true value for isOperational(). This active status can be overridden by setting isDisabled() to true. If there are no active OsidEnabler rules, isOperational() is false resulting in an off Operable unless isEnabled() is true .

For the active status to be completely determined by the OsidEnablers, both isEnabled() and isDisabled() should be false where the isActive() status is completely driven from isOperational().

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`isActive()` Tests if this operable is active.
`boolean`	`isDisabled()` Tests if this operable is administravely disabled.
`boolean`	`isEnabled()` Tests if this operable is administravely enabled.
`boolean`	`isOperational()` Tests if this `Operable` is operational.

- Method Detail
  - isActive
```
boolean isActive()
```
    Tests if this operable is active. isActive() is true if isOperational() is true and isDisabled() is false, or isEnabled() is true.
    
    Returns:
    true if this operable is on, false if it is off
    
    Compliance:
    mandatory - This method must be implemented.
  - isEnabled
```
boolean isEnabled()
```
    Tests if this operable is administravely enabled. Administratively enabling overrides any applied OsidEnabler. If this method returns true then isDisabled() must return false.
    
    Returns:
    true if this operable is enabled, false if the active status is determined by other rules
    
    Compliance:
    mandatory - This method must be implemented.
  - isDisabled
```
boolean isDisabled()
```
    Tests if this operable is administravely disabled. Administratively disabling overrides any applied OsidEnabler. If this method returns true then isEnabled() must return false.
    
    Returns:
    true if this operable is disabled, false if the active status is determined by other rules
    
    Compliance:
    mandatory - This method must be implemented.
  - isOperational
```
boolean isOperational()
```
    Tests if this Operable is operational. This Operable is operational if any of the applied OsidEnablers are true.
    
    Returns:
    true if this operable is operational, false otherwise
    
    Compliance:
    mandatory - This method must be implemented.

Interface Operable

Method Summary

Method Detail

isActive

isEnabled

isDisabled

isOperational