OSID — Offering Rules Entities

Canonical Unit Enabler

Osid Enabler

A CanonicalUnitEnabler describes the rules for making an OfferingConstrainer effective.

Like all OsidObjects, CanonicalUnitEnabler is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

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

Canonical Unit Processor

Osid Processor

A CanonicalUnitProcessor describes the rules for offering a canonical unit.

Like all OsidObjects, CanonicalUnitProcessor is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

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`

Canonical Unit Processor Enabler

Osid Enabler

An CanonicalUnitProcessorEnabler describes the rules for making an CanonicalUnitProcessor effective.

Like all OsidObjects, CanonicalUnitProcessorEnabler is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

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

Offering Constrainer

Osid Constrainer

An OfferingConstrainer describes the rules for constraining the bids in a canonical unit.

Like all OsidObjects, OfferingConstrainer is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

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	Description
`canOverrideDescription`	boolean	`true` if the description can be overridden, `false` if constrained
`canOverrideTitle`	boolean	`true` if the title can be overridden, `false` if constrained
`canOverrideCode`	boolean	`true` if the code can be overridden, `false` if constrained
`canOverrideTimePeriods`	boolean	`true` if the time period cycles can be overridden, `false` if constrained
`canConstrainTimePeriods`	boolean	`true` if the time period cycles can be optional, `false` if constrained
`canOverrideResultOptions`	boolean	`true` if the result options can be overridden, `false` if constrained
`canConstrainResultOptions`	boolean	`true` if the result options can be a subset, `false` otherwise
`canOverrideSponsors`	boolean	`true` if the sponsors can be overridden, `false` if constrained
`canConstrainSponsors`	boolean	`true` if the sponsors can be a subset, `false` otherwise

Offering Constrainer Enabler

Osid Enabler

An OfferingConstrainerEnabler describes the rules for making an OfferingConstrainer effective.

Like all OsidObjects, OfferingConstrainerEnabler is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

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

Offering Rules

CanonicalUnitEnabler Rule

CanonicalUnitProcessor Rule

OfferingConstrainer Rule

OfferingConstrainerEnabler Rule

CanonicalUnitProcessorEnabler Rule

Catalogue Cataloging

Canonical Unit Enabler

Canonical Unit Processor

Canonical Unit Processor Enabler

Offering Constrainer

Offering Constrainer Enabler