Class: SettlementBase

A base class to be extended by the SettlementTerms class.

 classDiagram
    class SettlementBase
    click SettlementBase href "../SettlementBase/"
      SettlementBase <|-- SettlementTerms
        click SettlementTerms href "../SettlementTerms/"
      
      SettlementBase : cashSettlementCentre
        
          
    
        
        
        SettlementBase --> "0..1" AssetAncillaryPartyRoleEnum : cashSettlementCentre
        click AssetAncillaryPartyRoleEnum href "../AssetAncillaryPartyRoleEnum/"
    

        
      SettlementBase : securitySettlementCentre
        
          
    
        
        
        SettlementBase --> "0..1" AssetAncillaryPartyRoleEnum : securitySettlementCentre
        click AssetAncillaryPartyRoleEnum href "../AssetAncillaryPartyRoleEnum/"
    

        
      SettlementBase : settlementCentre
        
          
    
        
        
        SettlementBase --> "0..1" SettlementCentreEnum : settlementCentre
        click SettlementCentreEnum href "../SettlementCentreEnum/"
    

        
      SettlementBase : settlementCurrency
        
      SettlementBase : settlementDate
        
          
    
        
        
        SettlementBase --> "0..1" SettlementDate : settlementDate
        click SettlementDate href "../SettlementDate/"
    

        
      SettlementBase : settlementProvision
        
          
    
        
        
        SettlementBase --> "0..1" SettlementProvision : settlementProvision
        click SettlementProvision href "../SettlementProvision/"
    

        
      SettlementBase : settlementType
        
          
    
        
        
        SettlementBase --> "1" SettlementTypeEnum : settlementType
        click SettlementTypeEnum href "../SettlementTypeEnum/"
    

        
      SettlementBase : standardSettlementStyle
        
          
    
        
        
        SettlementBase --> "0..1" StandardSettlementStyleEnum : standardSettlementStyle
        click StandardSettlementStyleEnum href "../StandardSettlementStyleEnum/"
    

        
      SettlementBase : transferSettlementType
        
          
    
        
        
        SettlementBase --> "0..1" TransferSettlementEnum : transferSettlementType
        click TransferSettlementEnum href "../TransferSettlementEnum/"

Inheritance

SettlementBase
- SettlementTerms

Slots

Name	Cardinality and Range	Description	Inheritance
settlementType	1 SettlementTypeEnum	Whether the settlement will be cash, physical, by election,	direct
transferSettlementType	0..1 TransferSettlementEnum	The qualification as to how the transfer will settle, e	direct
settlementCurrency	0..1 string	The settlement currency is to be specified when the Settlement Amount cannot …	direct
settlementDate	0..1 SettlementDate	The date on which the settlement amount will be paid, subject to adjustment i…	direct
settlementCentre	0..1 SettlementCentreEnum	Optional settlement centre as an enumerated list: Euroclear, Clearstream	direct
settlementProvision	0..1 SettlementProvision	Optionally defines the parameters that regulate a settlement	direct
standardSettlementStyle	0..1 StandardSettlementStyleEnum	Settlement Style	direct
securitySettlementCentre	0..1 AssetAncillaryPartyRoleEnum	Specifies the settlement centre of a security	direct
cashSettlementCentre	0..1 AssetAncillaryPartyRoleEnum	Specifies the settlement centre of cash	direct

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	`{'securitySettlementCentre': {'value_presence': 'PRESENT'}}`	`{'securitySettlementCentre': {'value_presence': 'PRESENT', 'equals_string': 'SecuritySettlementCentre'}}`

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	`{'cashSettlementCentre': {'value_presence': 'PRESENT'}}`	`{'cashSettlementCentre': {'value_presence': 'PRESENT', 'equals_string': 'CashSettlementCentre'}}`

Identifier and Mapping Information

Annotations

property	value
rosetta_metadata	key

Schema Source

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

Mappings

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

LinkML Source

Direct

name: SettlementBase
annotations:
  rosetta_metadata:
    tag: rosetta_metadata
    value: key
description: A base class to be extended by the SettlementTerms class.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  settlementType:
    name: settlementType
    description: Whether the settlement will be cash, physical, by election, ...
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    rank: 1000
    domain_of:
    - SettlementBase
    range: SettlementTypeEnum
    required: true
  transferSettlementType:
    name: transferSettlementType
    description: The qualification as to how the transfer will settle, e.g. a DvP
      settlement.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    rank: 1000
    domain_of:
    - SettlementBase
    range: TransferSettlementEnum
  settlementCurrency:
    name: settlementCurrency
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
      doc_reference:
        tag: doc_reference
        value: ICMA GMRA namingConvention Contractual Currency
    description: The settlement currency is to be specified when the Settlement Amount
      cannot be known in advance. 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_settlement
    rank: 1000
    domain_of:
    - SettlementBase
    range: string
  settlementDate:
    name: settlementDate
    description: The date on which the settlement amount will be paid, subject to
      adjustment in accordance with any applicable business day convention. This component
      would not be present for a mandatory early termination provision where the cash
      settlement payment date is the mandatory early termination date.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    domain_of:
    - BillingRecordInstruction
    - TransferBase
    - NonDeliverableSubstitute
    - SettlementBase
    - AssetLeg
    range: SettlementDate
  settlementCentre:
    name: settlementCentre
    description: 'Optional settlement centre as an enumerated list: Euroclear, Clearstream.'
    deprecated: Marked [deprecated] in the CDM.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    rank: 1000
    domain_of:
    - SettlementBase
    range: SettlementCentreEnum
  settlementProvision:
    name: settlementProvision
    description: Optionally defines the parameters that regulate a settlement.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    rank: 1000
    domain_of:
    - SettlementBase
    range: SettlementProvision
  standardSettlementStyle:
    name: standardSettlementStyle
    description: Settlement Style.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    rank: 1000
    domain_of:
    - SettlementBase
    range: StandardSettlementStyleEnum
  securitySettlementCentre:
    name: securitySettlementCentre
    description: Specifies the settlement centre of a security.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    rank: 1000
    domain_of:
    - SettlementBase
    range: AssetAncillaryPartyRoleEnum
  cashSettlementCentre:
    name: cashSettlementCentre
    description: Specifies the settlement centre of cash.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    rank: 1000
    domain_of:
    - SettlementBase
    range: AssetAncillaryPartyRoleEnum
rules:
- preconditions:
    slot_conditions:
      securitySettlementCentre:
        name: securitySettlementCentre
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      securitySettlementCentre:
        name: securitySettlementCentre
        value_presence: PRESENT
        equals_string: SecuritySettlementCentre
  description: SecuritySettlementCentre
- preconditions:
    slot_conditions:
      cashSettlementCentre:
        name: cashSettlementCentre
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      cashSettlementCentre:
        name: cashSettlementCentre
        value_presence: PRESENT
        equals_string: CashSettlementCentre
  description: CashSettlementCentre

Induced

name: SettlementBase
annotations:
  rosetta_metadata:
    tag: rosetta_metadata
    value: key
description: A base class to be extended by the SettlementTerms class.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  settlementType:
    name: settlementType
    description: Whether the settlement will be cash, physical, by election, ...
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    rank: 1000
    owner: SettlementBase
    domain_of:
    - SettlementBase
    range: SettlementTypeEnum
    required: true
  transferSettlementType:
    name: transferSettlementType
    description: The qualification as to how the transfer will settle, e.g. a DvP
      settlement.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    rank: 1000
    owner: SettlementBase
    domain_of:
    - SettlementBase
    range: TransferSettlementEnum
  settlementCurrency:
    name: settlementCurrency
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
      doc_reference:
        tag: doc_reference
        value: ICMA GMRA namingConvention Contractual Currency
    description: The settlement currency is to be specified when the Settlement Amount
      cannot be known in advance. 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_settlement
    rank: 1000
    owner: SettlementBase
    domain_of:
    - SettlementBase
    range: string
  settlementDate:
    name: settlementDate
    description: The date on which the settlement amount will be paid, subject to
      adjustment in accordance with any applicable business day convention. This component
      would not be present for a mandatory early termination provision where the cash
      settlement payment date is the mandatory early termination date.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    owner: SettlementBase
    domain_of:
    - BillingRecordInstruction
    - TransferBase
    - NonDeliverableSubstitute
    - SettlementBase
    - AssetLeg
    range: SettlementDate
  settlementCentre:
    name: settlementCentre
    description: 'Optional settlement centre as an enumerated list: Euroclear, Clearstream.'
    deprecated: Marked [deprecated] in the CDM.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    rank: 1000
    owner: SettlementBase
    domain_of:
    - SettlementBase
    range: SettlementCentreEnum
  settlementProvision:
    name: settlementProvision
    description: Optionally defines the parameters that regulate a settlement.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    rank: 1000
    owner: SettlementBase
    domain_of:
    - SettlementBase
    range: SettlementProvision
  standardSettlementStyle:
    name: standardSettlementStyle
    description: Settlement Style.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    rank: 1000
    owner: SettlementBase
    domain_of:
    - SettlementBase
    range: StandardSettlementStyleEnum
  securitySettlementCentre:
    name: securitySettlementCentre
    description: Specifies the settlement centre of a security.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    rank: 1000
    owner: SettlementBase
    domain_of:
    - SettlementBase
    range: AssetAncillaryPartyRoleEnum
  cashSettlementCentre:
    name: cashSettlementCentre
    description: Specifies the settlement centre of cash.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    rank: 1000
    owner: SettlementBase
    domain_of:
    - SettlementBase
    range: AssetAncillaryPartyRoleEnum
rules:
- preconditions:
    slot_conditions:
      securitySettlementCentre:
        name: securitySettlementCentre
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      securitySettlementCentre:
        name: securitySettlementCentre
        value_presence: PRESENT
        equals_string: SecuritySettlementCentre
  description: SecuritySettlementCentre
- preconditions:
    slot_conditions:
      cashSettlementCentre:
        name: cashSettlementCentre
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      cashSettlementCentre:
        name: cashSettlementCentre
        value_presence: PRESENT
        equals_string: CashSettlementCentre
  description: CashSettlementCentre