Class: Schedule

Specifies an amount or quantity, either as a single value or as a schedule of dated values. This can be used where the applicable quantity changes over time, with each dated value becoming effective from its associated step date.

URI: common_domain_model:Schedule

 classDiagram
    class Schedule
    click Schedule href "../Schedule/"
      Schedule <|-- MeasureBase
        click MeasureBase href "../MeasureBase/"
      Schedule <|-- NonNegativeSchedule
        click NonNegativeSchedule href "../NonNegativeSchedule/"
      Schedule <|-- ScheduleWithInitialValue
        click ScheduleWithInitialValue href "../ScheduleWithInitialValue/"
      
      Schedule : datedValue
        
          
    
        
        
        Schedule --> "*" DatedValue : datedValue
        click DatedValue href "../DatedValue/"
    

        
      Schedule : value

Inheritance

Schedule

Slots

Name	Cardinality and Range	Description	Inheritance
value	0..1 Decimal	The initial rate or amount, as the case may be	direct
datedValue	* DatedValue	The schedule of step date and value pairs	direct

Expressions & Logic

All Of

The class must satisfy all of:

AnonymousClassExpression({ ‘description’: (’ValueExists: A schedule may be specified as a single value or as a set of ’ ’date-value pairs. Both attributes may be specified, in which case the single ’ ‘amount number is the initial value.’), ‘any_of’: [AnonymousClassExpression({ ‘slot_conditions’: {‘value’: SlotDefinition({‘name’: ‘value’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} }), AnonymousClassExpression({ ‘slot_conditions’: {‘datedValue’: SlotDefinition({‘name’: ‘datedValue’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} })] })

Usages

used by	used in	type	used
NonNegativeQuantity	total	range	Schedule
Quantity	total	range	Schedule
QuantitySchedule	total	range	Schedule
Money	total	range	Schedule

Identifier and Mapping Information

Schema Source

from schema: https://w3id.org/lmodel/common-domain-model

Mappings

Mapping Type	Mapped Value
self	common_domain_model:Schedule
native	common_domain_model:Schedule

LinkML Source

Direct

name: Schedule
description: Specifies an amount or quantity, either as a single value or as a schedule
  of dated values. This can be used where the applicable quantity changes over time,
  with each dated value becoming effective from its associated step date.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  value:
    name: value
    description: The initial rate or amount, as the case may be. An initial rate of
      5% would be represented as 0.05.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_math
    domain_of:
    - DatedValue
    - Schedule
    - Taxonomy
    - TaxonomyClassification
    - CodeValue
    - AccrualFactor
    - AdjustmentFactor
    - ClauseLibraryVariableSet
    - CSAMinimumTransferAmountVariableSet
    - CSAThresholdVariableSet
    - DisputeResolution
    - OtherEligibleAndPostedSupport
    range: decimal
  datedValue:
    name: datedValue
    description: The schedule of step date and value pairs. On each step date the
      associated step value becomes effective. A list of steps may be ordered in the
      document by ascending step date. An FpML document containing an unordered list
      of steps is still regarded as a conformant document.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_math
    rank: 1000
    domain_of:
    - Schedule
    range: DatedValue
    multivalued: true
all_of:
- description: 'ValueExists: A schedule may be specified as a single value or as a
    set of date-value pairs. Both attributes may be specified, in which case the single
    amount number is the initial value.'
  any_of:
  - slot_conditions:
      value:
        name: value
        value_presence: PRESENT
  - slot_conditions:
      datedValue:
        name: datedValue
        value_presence: PRESENT

Induced

name: Schedule
description: Specifies an amount or quantity, either as a single value or as a schedule
  of dated values. This can be used where the applicable quantity changes over time,
  with each dated value becoming effective from its associated step date.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  value:
    name: value
    description: The initial rate or amount, as the case may be. An initial rate of
      5% would be represented as 0.05.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_math
    owner: Schedule
    domain_of:
    - DatedValue
    - Schedule
    - Taxonomy
    - TaxonomyClassification
    - CodeValue
    - AccrualFactor
    - AdjustmentFactor
    - ClauseLibraryVariableSet
    - CSAMinimumTransferAmountVariableSet
    - CSAThresholdVariableSet
    - DisputeResolution
    - OtherEligibleAndPostedSupport
    range: decimal
  datedValue:
    name: datedValue
    description: The schedule of step date and value pairs. On each step date the
      associated step value becomes effective. A list of steps may be ordered in the
      document by ascending step date. An FpML document containing an unordered list
      of steps is still regarded as a conformant document.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_math
    rank: 1000
    owner: Schedule
    domain_of:
    - Schedule
    range: DatedValue
    multivalued: true
all_of:
- description: 'ValueExists: A schedule may be specified as a single value or as a
    set of date-value pairs. Both attributes may be specified, in which case the single
    amount number is the initial value.'
  any_of:
  - slot_conditions:
      value:
        name: value
        value_presence: PRESENT
  - slot_conditions:
      datedValue:
        name: datedValue
        value_presence: PRESENT