Skip to content

Class: AmountSchedule

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

URI: common_domain_model:AmountSchedule

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

      AmountSchedule : currency

      AmountSchedule : datedValue





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



      AmountSchedule : value

Inheritance

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, as the case may be Schedule
datedValue *
DatedValue		 The schedule of step date and value pairs Schedule

Usages

used by used in type used
ExerciseFeeSchedule feeAmountSchedule range AmountSchedule

In Subsets

Identifier and Mapping Information

Schema Source

Mappings

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

LinkML Source

Direct

name: AmountSchedule
description: A class to specify a currency amount or a currency amount schedule.
in_subset:
- cdm_product_common_schedule
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: Schedule
slots:
- currency
slot_usage:
  currency:
    name: currency
    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.
    required: true
    multivalued: true

Induced

name: AmountSchedule
description: A class to specify a currency amount or a currency amount schedule.
in_subset:
- cdm_product_common_schedule
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: Schedule
slot_usage:
  currency:
    name: currency
    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.
    required: true
    multivalued: true
attributes:
  currency:
    name: currency
    annotations:
      metadata_scheme:
        tag: metadata_scheme
        value: true
    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
    rank: 1000
    owner: AmountSchedule
    domain_of:
    - UnitType
    - CommodityReferenceFramework
    - NotDomesticCurrency
    - SpecifiedCurrency
    - LimitApplicable
    - CalculationCurrencyElection
    - CollateralRounding
    - TerminationCurrencyElection
    - ThresholdRatingsBased
    - MinimumTransferAmountRatingsBased
    - LegacyIndependentAmountRatingsBased
    - FloatingRateIndexIdentification
    - FeaturePayment
    - DividendCurrency
    - FutureValueAmount
    - AmountSchedule
    - CollateralInterestParameters
    - ComputedAmount
    range: string
    required: true
    multivalued: true
  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
    rank: 1000
    owner: AmountSchedule
    domain_of:
    - MeasureBase
    - Schedule
    - DatedValue
    - Taxonomy
    - TaxonomyClassification
    - CodeValue
    - AdjustmentFactor
    - AccrualFactor
    - DisputeResolution
    - OtherEligibleAndPostedSupport
    - CSAThresholdVariableSet
    - CSAMinimumTransferAmountVariableSet
    - MasterAgreementVariableSet
    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
    rank: 1000
    owner: AmountSchedule
    domain_of:
    - MeasureSchedule
    - Schedule
    range: DatedValue
    multivalued: true
    inlined: true
    inlined_as_list: true