Skip to content

Class: ReturnAmount

A class to specify the application of Interest Amount with respect the Return Amount.

URI: common_domain_model:ReturnAmount

 classDiagram
    class ReturnAmount
    click ReturnAmount href "../ReturnAmount/"
      ReturnAmount : customElection

      ReturnAmount : includesDefaultLanguage

Slots

Name Cardinality and Range Description Inheritance
includesDefaultLanguage 0..1
Boolean		 Default language is included when True, and excluded when False direct
customElection 0..1
string		 Custom election that might be specified by the parties to the agreement direct

Usages

used by used in type used
InterestAmount returnAmount range ReturnAmount
InterestAmountApplication returnAmount range ReturnAmount

Rules

Rule Applied Preconditions Postconditions Elseconditions
slot_conditions {'customElection': {'required': True}} {'includesDefaultLanguage': {'equals_string': 'False'}}

In Subsets

Comments

  • Rosetta condition: CustomElection — if customElection exists then includesDefaultLanguage = False

Identifier and Mapping Information

Schema Source

Mappings

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

LinkML Source

Direct

name: ReturnAmount
description: A class to specify the application of Interest Amount with respect the
  Return Amount.
comments:
- 'Rosetta condition: CustomElection — if customElection exists then includesDefaultLanguage
  = False'
in_subset:
- cdm_product_collateral
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- includesDefaultLanguage
- customElection
slot_usage:
  customElection:
    name: customElection
    description: Custom election that might be specified by the parties to the agreement.
rules:
- preconditions:
    slot_conditions:
      customElection:
        name: customElection
        required: true
  postconditions:
    slot_conditions:
      includesDefaultLanguage:
        name: includesDefaultLanguage
        equals_string: 'False'
  description: A data rule to specify that when a custom election exists then default
    language should not be included.

Induced

name: ReturnAmount
description: A class to specify the application of Interest Amount with respect the
  Return Amount.
comments:
- 'Rosetta condition: CustomElection — if customElection exists then includesDefaultLanguage
  = False'
in_subset:
- cdm_product_collateral
from_schema: https://w3id.org/lmodel/common-domain-model
slot_usage:
  customElection:
    name: customElection
    description: Custom election that might be specified by the parties to the agreement.
attributes:
  includesDefaultLanguage:
    name: includesDefaultLanguage
    description: Default language is included when True, and excluded when False.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ReturnAmount
    domain_of:
    - ReturnAmount
    range: boolean
  customElection:
    name: customElection
    description: Custom election that might be specified by the parties to the agreement.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AdditionalRepresentation.customElection
    rank: 1000
    owner: ReturnAmount
    domain_of:
    - AdditionalRepresentation
    - ElectiveAmountElection
    - InterestAdjustmentPeriodicity
    - SecurityProviderRightsEvent
    - ReturnAmount
    - DeliveryAmount
    range: string
rules:
- preconditions:
    slot_conditions:
      customElection:
        name: customElection
        required: true
  postconditions:
    slot_conditions:
      includesDefaultLanguage:
        name: includesDefaultLanguage
        equals_string: 'False'
  description: A data rule to specify that when a custom election exists then default
    language should not be included.