Recurring Event Enabler
A RecurringEventEnabler describes the
rules for making a RecurringEvent
effective.
Like all OsidObjects,
RecurringEventEnabler is managed by its
OsidSessions and may not be accessed by
concurrent processing threads.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Operable | |||
isActive |
boolean | true if this operable is active, false if it is
inactive |
|
isEnabled |
boolean | true if this operable is enabled, false if the
active status is determined by other rules |
|
isDisabled |
boolean | true if this operable is disabled, false if the
active status is determined by other rules |
|
isOperational |
boolean | true if this operable is operational, false
otherwise |
|
| OsidRule | |||
hasRule |
boolean | true if an explicit rule is available, false
otherwise |
|
ruleId |
id | the rule Id |
|
rule |
Rule | the rule | |
conditionRecordTypes |
type | ⋆ | a list of OsidCondition record Types |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidEnabler | |||
isRequirement |
boolean | true if this enabler is a requirement, false
otherwise |
|
isOperationalOnSchedule |
boolean | true if the enabler is operational on a schedule,
false otherwise |
|
scheduleId |
id | the schedule Id |
|
schedule |
Schedule | the schedule | |
isOperationalDuringEvent |
boolean | true if the enabler is operational for an event,
false otherwise |
|
eventId |
id | the event Id |
|
event |
Event | the event | |
isOperationalDuringCyclicEvent |
boolean | true if the enabler is governed by a cyclic event,
false otherwise |
|
cyclicEventId |
id | the cyclic event Id |
|
cyclicEvent |
CyclicEvent | the cyclic event | |
isOperationalDuringTimePeriod |
boolean | true if the enabler applied to a time period,
false otherwise |
|
timePeriodId |
id | the time period Id |
|
timePeriod |
TimePeriod | the time period | |
isOperationalDuringCyclicTimePeriod |
boolean | true if the enabler is appleid to a cycic time period,
false otherwise |
|
cyclicTimePeriodId |
id | the cyclic time period Id |
|
cyclicTimePeriod |
CyclicTimePeriod | the cyclic time period | |
Offset Event Enabler
An OffsetEventEnabler describes the
rules for making an OffsetEvent
effective.
Like all OsidObjects,
OffsetEventEnabler is managed by its
OsidSessions and may not be accessed by
concurrent processing threads.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Operable | |||
isActive |
boolean | true if this operable is active, false if it is
inactive |
|
isEnabled |
boolean | true if this operable is enabled, false if the
active status is determined by other rules |
|
isDisabled |
boolean | true if this operable is disabled, false if the
active status is determined by other rules |
|
isOperational |
boolean | true if this operable is operational, false
otherwise |
|
| OsidRule | |||
hasRule |
boolean | true if an explicit rule is available, false
otherwise |
|
ruleId |
id | the rule Id |
|
rule |
Rule | the rule | |
conditionRecordTypes |
type | ⋆ | a list of OsidCondition record Types |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidEnabler | |||
isRequirement |
boolean | true if this enabler is a requirement, false
otherwise |
|
isOperationalOnSchedule |
boolean | true if the enabler is operational on a schedule,
false otherwise |
|
scheduleId |
id | the schedule Id |
|
schedule |
Schedule | the schedule | |
isOperationalDuringEvent |
boolean | true if the enabler is operational for an event,
false otherwise |
|
eventId |
id | the event Id |
|
event |
Event | the event | |
isOperationalDuringCyclicEvent |
boolean | true if the enabler is governed by a cyclic event,
false otherwise |
|
cyclicEventId |
id | the cyclic event Id |
|
cyclicEvent |
CyclicEvent | the cyclic event | |
isOperationalDuringTimePeriod |
boolean | true if the enabler applied to a time period,
false otherwise |
|
timePeriodId |
id | the time period Id |
|
timePeriod |
TimePeriod | the time period | |
isOperationalDuringCyclicTimePeriod |
boolean | true if the enabler is appleid to a cycic time period,
false otherwise |
|
cyclicTimePeriodId |
id | the cyclic time period Id |
|
cyclicTimePeriod |
CyclicTimePeriod | the cyclic time period | |
Superseding Event Enabler
A SupersedingEventEnabler describes
the rules for making a SupersedingEvent
effective.
Like all OsidObjects,
SupersedingEventEnabler is managed by its
OsidSessions and may not be accessed by
concurrent processing threads.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Operable | |||
isActive |
boolean | true if this operable is active, false if it is
inactive |
|
isEnabled |
boolean | true if this operable is enabled, false if the
active status is determined by other rules |
|
isDisabled |
boolean | true if this operable is disabled, false if the
active status is determined by other rules |
|
isOperational |
boolean | true if this operable is operational, false
otherwise |
|
| OsidRule | |||
hasRule |
boolean | true if an explicit rule is available, false
otherwise |
|
ruleId |
id | the rule Id |
|
rule |
Rule | the rule | |
conditionRecordTypes |
type | ⋆ | a list of OsidCondition record Types |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidEnabler | |||
isRequirement |
boolean | true if this enabler is a requirement, false
otherwise |
|
isOperationalOnSchedule |
boolean | true if the enabler is operational on a schedule,
false otherwise |
|
scheduleId |
id | the schedule Id |
|
schedule |
Schedule | the schedule | |
isOperationalDuringEvent |
boolean | true if the enabler is operational for an event,
false otherwise |
|
eventId |
id | the event Id |
|
event |
Event | the event | |
isOperationalDuringCyclicEvent |
boolean | true if the enabler is governed by a cyclic event,
false otherwise |
|
cyclicEventId |
id | the cyclic event Id |
|
cyclicEvent |
CyclicEvent | the cyclic event | |
isOperationalDuringTimePeriod |
boolean | true if the enabler applied to a time period,
false otherwise |
|
timePeriodId |
id | the time period Id |
|
timePeriod |
TimePeriod | the time period | |
isOperationalDuringCyclicTimePeriod |
boolean | true if the enabler is appleid to a cycic time period,
false otherwise |
|
cyclicTimePeriodId |
id | the cyclic time period Id |
|
cyclicTimePeriod |
CyclicTimePeriod | the cyclic time period | |
Commitment Enabler
A CommitmentEnabler describes the
rules for making Commitments effective.
Like all OsidObjects,
CommitmentEnabler is managed by its
OsidSessions and may not be accessed by
concurrent processing threads.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Operable | |||
isActive |
boolean | true if this operable is active, false if it is
inactive |
|
isEnabled |
boolean | true if this operable is enabled, false if the
active status is determined by other rules |
|
isDisabled |
boolean | true if this operable is disabled, false if the
active status is determined by other rules |
|
isOperational |
boolean | true if this operable is operational, false
otherwise |
|
| OsidRule | |||
hasRule |
boolean | true if an explicit rule is available, false
otherwise |
|
ruleId |
id | the rule Id |
|
rule |
Rule | the rule | |
conditionRecordTypes |
type | ⋆ | a list of OsidCondition record Types |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidEnabler | |||
isRequirement |
boolean | true if this enabler is a requirement, false
otherwise |
|
isOperationalOnSchedule |
boolean | true if the enabler is operational on a schedule,
false otherwise |
|
scheduleId |
id | the schedule Id |
|
schedule |
Schedule | the schedule | |
isOperationalDuringEvent |
boolean | true if the enabler is operational for an event,
false otherwise |
|
eventId |
id | the event Id |
|
event |
Event | the event | |
isOperationalDuringCyclicEvent |
boolean | true if the enabler is governed by a cyclic event,
false otherwise |
|
cyclicEventId |
id | the cyclic event Id |
|
cyclicEvent |
CyclicEvent | the cyclic event | |
isOperationalDuringTimePeriod |
boolean | true if the enabler applied to a time period,
false otherwise |
|
timePeriodId |
id | the time period Id |
|
timePeriod |
TimePeriod | the time period | |
isOperationalDuringCyclicTimePeriod |
boolean | true if the enabler is appleid to a cycic time period,
false otherwise |
|
cyclicTimePeriodId |
id | the cyclic time period Id |
|
cyclicTimePeriod |
CyclicTimePeriod | the cyclic time period | |