Dispatch Enabler
Osid Enabler
A DispatchEnabler manages the active
status of a Dispatch.
| 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 | |
Dispatch Constrainer
Osid Constrainer
A DispatchConstrainer manages the
constraints of a Dispatch.
| 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 |
Dispatch Constrainer Enabler
Osid Enabler
A DispatchConstrainerEnabler manages
the active status of a
DispatchConstrainer.
| 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 | |
Dispatch Processor
Osid Processor
A DispatchProcessor manages the
operation of a Dispatch.
| 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 |
Dispatch Processor Enabler
Osid Enabler
A DispatchProcessorEnabler manages
the active status of a DispatchProcessor
..
| 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 | |
Subscription Enabler
Osid Enabler
A SubscriptionEnabler describes the
rules for making Subscriptions effective.
| 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 | |