Class: ScheduleWithInitialValue

A class defining a schedule of rates or amounts in terms of an initial value and then a series of step date and value pairs. On each step date the rate or amount changes to the new step value. The series of step date and value pairs are optional. If not specified, this implies that the initial value remains unchanged over time.

URI: common_domain_model:ScheduleWithInitialValue

 classDiagram
    class ScheduleWithInitialValue
    click ScheduleWithInitialValue href "../ScheduleWithInitialValue/"
      Schedule <|-- ScheduleWithInitialValue
        click Schedule href "../Schedule/"
      

      ScheduleWithInitialValue <|-- AmountScheduleWithInitialValue
        click AmountScheduleWithInitialValue href "../AmountScheduleWithInitialValue/"
      

      ScheduleWithInitialValue : datedValue
        
          
    
        
        
        ScheduleWithInitialValue --> "*" DatedValue : datedValue
        click DatedValue href "../DatedValue/"
    

        
      ScheduleWithInitialValue : value
        
      

Inheritance

• Schedule
  • ScheduleWithInitialValue
    • AmountScheduleWithInitialValue

Slots

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

Expressions & Logic

All Of

The class must satisfy all of:

• AnonymousClassExpression({ ‘description’: (’From Schedule. 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
StubFloatingRate	floatingRateMultiplierSchedule	range	ScheduleWithInitialValue
ExerciseFeeSchedule	feeRateSchedule	range	ScheduleWithInitialValue

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: ScheduleWithInitialValue
description: A class defining a schedule of rates or amounts in terms of an initial
  value and then a series of step date and value pairs. On each step date the rate
  or amount changes to the new step value. The series of step date and value pairs
  are optional. If not specified, this implies that the initial value remains unchanged
  over time.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: Schedule
slot_usage:
  value:
    name: value
    description: The initial rate or amount must be specified, as the case may be.
      An initial rate of 5% would be represented as 0.05.
    range: decimal
    required: true
all_of:
- description: 'From Schedule. 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: ScheduleWithInitialValue
description: A class defining a schedule of rates or amounts in terms of an initial
  value and then a series of step date and value pairs. On each step date the rate
  or amount changes to the new step value. The series of step date and value pairs
  are optional. If not specified, this implies that the initial value remains unchanged
  over time.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: Schedule
slot_usage:
  value:
    name: value
    description: The initial rate or amount must be specified, as the case may be.
      An initial rate of 5% would be represented as 0.05.
    range: decimal
    required: true
attributes:
  value:
    name: value
    description: The initial rate or amount must be specified, 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
    owner: ScheduleWithInitialValue
    domain_of:
    - DatedValue
    - Schedule
    - Taxonomy
    - TaxonomyClassification
    - CodeValue
    - AccrualFactor
    - AdjustmentFactor
    - ClauseLibraryVariableSet
    - CSAMinimumTransferAmountVariableSet
    - CSAThresholdVariableSet
    - DisputeResolution
    - OtherEligibleAndPostedSupport
    range: decimal
    required: true
  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: ScheduleWithInitialValue
    domain_of:
    - Schedule
    range: DatedValue
    multivalued: true
all_of:
- description: 'From Schedule. 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