Class: AmountScheduleWithInitialValue

A class to specify a currency amount or a currency amount schedule.

URI: common_domain_model:AmountScheduleWithInitialValue

 classDiagram
    class AmountScheduleWithInitialValue
    click AmountScheduleWithInitialValue href "../AmountScheduleWithInitialValue/"
      ScheduleWithInitialValue <|-- AmountScheduleWithInitialValue
        click ScheduleWithInitialValue href "../ScheduleWithInitialValue/"
      
      AmountScheduleWithInitialValue : currency
        
      AmountScheduleWithInitialValue : datedValue
        
          
    
        
        
        AmountScheduleWithInitialValue --> "*" DatedValue : datedValue
        click DatedValue href "../DatedValue/"
    

        
      AmountScheduleWithInitialValue : value
        
      

Inheritance

• Schedule
  • ScheduleWithInitialValue
    • AmountScheduleWithInitialValue

Slots

Name	Cardinality and Range	Description	Inheritance
currency	1..* string	The currency in which the amount schedule is denominated	direct
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
ExerciseFeeSchedule	feeAmountSchedule	range	AmountScheduleWithInitialValue

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: AmountScheduleWithInitialValue
description: A class to specify a currency amount or a currency amount schedule.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: ScheduleWithInitialValue
attributes:
  currency:
    name: currency
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
    description: The currency in which the amount schedule is denominated. The currency
      is specified outside of the actual schedule in order to be applied uniformly
      to it. The list of valid currencies is not presently positioned as an enumeration
      as part of the CDM because that scope is limited to the values specified by
      ISDA and FpML. As a result, implementers have to make reference to the relevant
      standard, such as the ISO 4217 standard for currency codes.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_schedule
    domain_of:
    - UnitType
    - CommodityReferenceFramework
    - NotDomesticCurrency
    - SpecifiedCurrency
    - FloatingRateIndexIdentification
    - AmountScheduleWithInitialValue
    - LimitApplicable
    - CalculationCurrencyElection
    - CollateralRounding
    - LegacyIndependentAmountRatingsBased
    - MinimumTransferAmountRatingsBased
    - TerminationCurrencyElection
    - ThresholdRatingsBased
    - FeaturePayment
    - DividendCurrency
    - FutureValueAmount
    - CollateralInterestParameters
    - ComputedAmount
    range: string
    required: true
    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

Induced

name: AmountScheduleWithInitialValue
description: A class to specify a currency amount or a currency amount schedule.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: ScheduleWithInitialValue
attributes:
  currency:
    name: currency
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
    description: The currency in which the amount schedule is denominated. The currency
      is specified outside of the actual schedule in order to be applied uniformly
      to it. The list of valid currencies is not presently positioned as an enumeration
      as part of the CDM because that scope is limited to the values specified by
      ISDA and FpML. As a result, implementers have to make reference to the relevant
      standard, such as the ISO 4217 standard for currency codes.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_schedule
    owner: AmountScheduleWithInitialValue
    domain_of:
    - UnitType
    - CommodityReferenceFramework
    - NotDomesticCurrency
    - SpecifiedCurrency
    - FloatingRateIndexIdentification
    - AmountScheduleWithInitialValue
    - LimitApplicable
    - CalculationCurrencyElection
    - CollateralRounding
    - LegacyIndependentAmountRatingsBased
    - MinimumTransferAmountRatingsBased
    - TerminationCurrencyElection
    - ThresholdRatingsBased
    - FeaturePayment
    - DividendCurrency
    - FutureValueAmount
    - CollateralInterestParameters
    - ComputedAmount
    range: string
    required: true
    multivalued: true
  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: AmountScheduleWithInitialValue
    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: AmountScheduleWithInitialValue
    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