Broker Enabler
A BrokerEnabler manages the active
status of a Broker.
| 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 | |
Broker Constrainer
A BrokerConstrainer manages the
constraints of a Broker.
| 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 |
Broker Constrainer Enabler
A BrokerConstrainerEnabler manages
the active status of a BrokerConstrainer.
| 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 | |
Broker Processor
A BrokerProcessor manages the
operation of a Broker.
| 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 |
| Name | Syntax | Many | Description |
|---|---|---|---|
isLeasing |
boolean | true if this is a leasing broker, false if the brokered provisions are permanent | |
hasFixedLeaseDuration |
boolean | true if leases have fixed durations, false
otherwise |
|
fixedLeaseDuration |
duration | the fixed lease duration | |
mustReturnProvisions |
boolean | true if this broker requires provision return,
false otherwise |
|
allowsProvisionExchange |
boolean | true if provision exchange is permitted, false
otherwise |
|
allowsCompoundRequests |
boolean | true if compound requests are permitted, false
otherwise |
Broker Processor Enabler
A BrokerProcessorEnabler manages the
active status of a BrokerProcessor..
| 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 | |
Queue Enabler
A QueueEnabler manages the active
status of a Queue.
| 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 | |
Queue Constrainer
A QueueConstrainer manages the
constraints of a Queue.
| 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 |
| Name | Syntax | Many | Description |
|---|---|---|---|
hasSizeLimit |
boolean | true if a queue size limit is available, false
otherwise |
|
sizeLimit |
cardinal | the size limit | |
requiresProvisions |
boolean | true if a provision is required, false otherwise |
|
requiredProvisionPoolIds |
id | ⋆ | the Ids of the pools |
requiredProvisionPools |
Pool | ⋆ | the pools |
Queue Constrainer Enabler
A QueueConstrainerEnabler manages the
active status of a QueueConstrainer.
| 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 | |
Queue Processor
A QueueProcessor manages the
operation of a Queue.
| 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 |
| Name | Syntax | Many | Description |
|---|---|---|---|
isAutomatic |
boolean | true if the queue processing is automatic, false
if processed manually |
|
isFifo |
boolean | true if the queue is a fifo, false otherwise |
|
removesProcessedQueueEntries |
boolean | true if the processed entries are removed, false
if processed queue entries remain but marked ineffective |
Queue Processor Enabler
A QueueProcessorEnabler manages the
active status of a QueueProcessor..
| 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 | |
Pool Enabler
A PoolEnabler manages the active
status of a Pool.
| 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 | |
Pool Constrainer
A PoolConstrainer manages the
constraints of a Pool.
| 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 |
Pool Constrainer Enabler
A PoolConstrainerEnabler manages the
active status of a PoolConstrainer.
| 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 | |
Pool Processor
A PoolProcessor describes the rules
for managing resource allocations out of a pool.
| 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 |
| Name | Syntax | Many | Description |
|---|---|---|---|
allocatesByLeastUse |
boolean | true if the least used provisionables are preferred,
false otherwise |
|
allocatesByMostUse |
boolean | true if the most used provisionables are preferred,
false otherwise |
|
allocatesByLeastCost |
boolean | true if the cheapest provisionables are preferred,
false otherwise |
|
allocatesByMostCost |
boolean | true if the most expensive provisionables are prefsrred,
false otherwise |
Pool Processor Enabler
A PoolProcessorEnabler describes the
rules for making a PoolProcessor
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 | |
Provisionable Enabler
A ProvisionableEnabler manages the
active status of a Provisionable.
| 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 | |
Provision Enabler
A ProvisionEnabler manages the active
status of a Provision.
| 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 | |