Interface OsidOperator
- All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidEnabler, OsidObject, OsidRule, Temporal
An OsidOperator is an OsidEnabler that governs the
operational status of an Operable . The OsidOperator
itself may be active or inactive. An Operable is operational when
any applied OsidOperator is active. When all applied
OsidOperators are inactive, then the Operable is not operational.
If isRequirement() is true , then this
OsidOperator must be active regardless of the state of any other applied
OsidOperators .
Operables are active or inactive. Operables may change
their operational status over time, but if two evaluations occur at the
same point in time each of the evaluations should see the same operational
status. For example, a bridge can be open or closed, but it cannot be open
for one car and closed for another car at the same time.
OsidOperators are rules which govern the Operable status over
time but OsidOperators do not incorporate context that varies from
one perspective to the next.
OsidOperators define several built-in dimensions to govern its
operational status.
- effective dates: The
OsidEnableris operational during these dates and evaluated using a date. - schedule: The
OsidEnableris operational when the date is occurs on theScheduleand the date is within the effective dates. - event: The
OsidEnableris operational when the date occurs within theEventand the date is within the effective dates.Eventsmay be comprised ofSchedulesand other rules making them discontinuous. - cyclic event: The
OsidEnableris operational when the date cccurs within theCyclicEventand the date is within the effective dates.CyclicEventsmay be complex recurring events but also recur from one time period to the next, such as annually. - time period: The
OsidEnableris operational during aTimePeriod. - cyclic time period: The
OsidEnableris operational during a recurringTimePeriod. For example, any Spring term.
-
Method Summary
Methods inherited from interface Browsable
getProperties, getPropertiesByRecordTypeModifier and TypeMethodDescriptionGets a list of properties.getPropertiesByRecordType(Type recordType) Gets a list of properties corresponding to the specified record type.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface Identifiable
getId, isCurrentMethods inherited from interface Operable
isActive, isDisabled, isEnabled, isOperationalModifier and TypeMethodDescriptionbooleanisActive()Tests if this operable is active.booleanTests if this operable is administravely disabled.booleanTests if this operable is administravely enabled.booleanTests if thisOperableis operational.Methods inherited from interface OsidEnabler
getCyclicEvent, getCyclicEventId, getCyclicTimePeriod, getCyclicTimePeriodId, getEvent, getEventId, getSchedule, getScheduleId, getTimePeriod, getTimePeriodId, isOperationalDuringCyclicEvent, isOperationalDuringCyclicTimePeriod, isOperationalDuringEvent, isOperationalDuringTimePeriod, isOperationalOnSchedule, isRequirementModifier and TypeMethodDescriptionGets the cyclic event.Gets the cyclic eventId.Gets the cyclic time period.Gets the cyclic time periodId.getEvent()Gets the event.Gets the eventId.Gets the schedule.Gets the scheduleId.Gets the time period.Gets the time periodId.booleanTests if the operational status of the enabler is governed by aCyclicEvent.booleanTests if this enabler is applied to a recurringCyclicTimePeriod.booleanTests if the operational status of the enabler is governed by anEvent.booleanTests if this enabler is applied to aTimePeriod.booleanTests if the operational status of the enabler is governed by aSchedule.booleanTests if thisOsidEnableris a requirement.Methods inherited from interface OsidObject
getDescription, getDisplayName, getGenusType, isOfGenusTypeModifier and TypeMethodDescriptionGets the description associated with this instance of this OSID object.Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.Gets the genus type of this object.booleanisOfGenusType(Type genusType) Tests if this object is of the given genusType.Methods inherited from interface OsidRule
getConditionRecordTypes, getRule, getRuleId, hasRuleMethods inherited from interface Temporal
getEndDate, getStartDate, isEffectiveModifier and TypeMethodDescriptionGets the end date.Gets the start date.booleanTests if the current date is within the start end end dates inclusive.