Class: AgreementName

Specifies the agreement name through an agreement type and optional detailed sub agreement type.

 classDiagram
    class AgreementName
    click AgreementName href "../AgreementName/"
      AgreementName : agreementType





        AgreementName --> "1" LegalAgreementTypeEnum : agreementType
        click LegalAgreementTypeEnum href "../LegalAgreementTypeEnum/"



      AgreementName : brokerConfirmationType





        AgreementName --> "0..1" BrokerConfirmationTypeEnum : brokerConfirmationType
        click BrokerConfirmationTypeEnum href "../BrokerConfirmationTypeEnum/"



      AgreementName : contractualDefinitionsType





        AgreementName --> "*" ContractualDefinitionsEnum : contractualDefinitionsType
        click ContractualDefinitionsEnum href "../ContractualDefinitionsEnum/"



      AgreementName : contractualMatrix





        AgreementName --> "*" ContractualMatrix : contractualMatrix
        click ContractualMatrix href "../ContractualMatrix/"



      AgreementName : contractualTermsSupplement





        AgreementName --> "*" ContractualTermsSupplement : contractualTermsSupplement
        click ContractualTermsSupplement href "../ContractualTermsSupplement/"



      AgreementName : creditSupportAgreementMarginType





        AgreementName --> "0..1" CollateralMarginTypeEnum : creditSupportAgreementMarginType
        click CollateralMarginTypeEnum href "../CollateralMarginTypeEnum/"



      AgreementName : creditSupportAgreementType





        AgreementName --> "0..1" CreditSupportAgreementTypeEnum : creditSupportAgreementType
        click CreditSupportAgreementTypeEnum href "../CreditSupportAgreementTypeEnum/"



      AgreementName : masterAgreementType





        AgreementName --> "0..1" MasterAgreementTypeEnum : masterAgreementType
        click MasterAgreementTypeEnum href "../MasterAgreementTypeEnum/"



      AgreementName : masterConfirmationAnnexType





        AgreementName --> "0..1" MasterConfirmationAnnexTypeEnum : masterConfirmationAnnexType
        click MasterConfirmationAnnexTypeEnum href "../MasterConfirmationAnnexTypeEnum/"



      AgreementName : masterConfirmationType





        AgreementName --> "0..1" MasterConfirmationTypeEnum : masterConfirmationType
        click MasterConfirmationTypeEnum href "../MasterConfirmationTypeEnum/"



      AgreementName : otherAgreement

Slots

Name	Cardinality and Range	Description	Inheritance
agreementType	1 LegalAgreementTypeEnum	Specification of the legal agreement type	direct
creditSupportAgreementType	0..1 CreditSupportAgreementTypeEnum	Specification of the credit support agreement type	direct
creditSupportAgreementMarginType	0..1 CollateralMarginTypeEnum	specifies the type of margin for which a legal agreement is named	direct
contractualDefinitionsType	* ContractualDefinitionsEnum	The definitions such as those published by ISDA that will define the terms of...	direct
contractualTermsSupplement	* ContractualTermsSupplement	A contractual supplement (such as those published by ISDA) that will apply to...	direct
contractualMatrix	* ContractualMatrix	A reference to a contractual matrix of elected terms/values (such as those pu...	direct
masterAgreementType	0..1 MasterAgreementTypeEnum	Specification of the master agreement type	direct
masterConfirmationType	0..1 MasterConfirmationTypeEnum	The type of master confirmation executed between the parties	direct
masterConfirmationAnnexType	0..1 MasterConfirmationAnnexTypeEnum	The type of master confirmation annex executed between the parties	direct
otherAgreement	0..1 string	Definition of an agreement that is not enumerated in the CDM	direct
brokerConfirmationType	0..1 BrokerConfirmationTypeEnum		direct

Usages

used by	used in	type	used
MarginCallBase	callAgreementType	range	AgreementName
MarginCallExposure	callAgreementType	range	AgreementName
MarginCallIssuance	callAgreementType	range	AgreementName
MarginCallResponse	callAgreementType	range	AgreementName
LegalAgreementIdentification	agreementName	range	AgreementName

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	`{'agreementType': {'equals_string': 'CreditSupportAgreement'}}`	`{'creditSupportAgreementType': {'required': True}}`

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	`{'masterConfirmationAnnexType': {'required': True}}`	`{'masterConfirmationType': {'required': True}}`

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	`{'creditSupportAgreementMarginType': {'required': True}}`	`{'creditSupportAgreementType': {'required': True}}`

In Subsets

CdmLegaldocumentationCommon

Comments

Rosetta condition: AgreementType — if agreementType <> LegalAgreementTypeEnum -> Other then otherAgreement is absent else if agreementType <> LegalAgreementTypeEnum -> MasterAgreement then masterAgreementType is absent else if agreementType <> LegalAgreementTypeEnum -> MasterConfirmation then masterConfirmationType is absent and masterConfirmationAnnexType is absent else if agreementType <> LegalAgreementTypeEnum -> Confirmation then contractualDefinitionsType is absent and contractualTermsSupplement is absent and contractualMatrix is absent
Rosetta condition: CreditSupportAgreement — if agreementType = LegalAgreementTypeEnum -> CreditSupportAgreement then creditSupportAgreementType exists
Rosetta condition: MasterConfirmation — if masterConfirmationAnnexType exists then masterConfirmationType exists
Rosetta condition: CSAMarginType — if creditSupportAgreementMarginType exists then creditSupportAgreementType exists

Identifier and Mapping Information

Schema Source

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

Mappings

Mapping Type	Mapped Value
self	common_domain_model:AgreementName
native	common_domain_model:AgreementName
close	fpml_5_10:AgreementName

LinkML Source

Direct

name: AgreementName
description: Specifies the agreement name through an agreement type and optional detailed
  sub agreement type.
comments:
- 'Rosetta condition: AgreementType — if agreementType <> LegalAgreementTypeEnum ->
  Other then otherAgreement is absent else if agreementType <> LegalAgreementTypeEnum
  -> MasterAgreement then masterAgreementType is absent else if agreementType <> LegalAgreementTypeEnum
  -> MasterConfirmation then masterConfirmationType is absent and masterConfirmationAnnexType
  is absent else if agreementType <> LegalAgreementTypeEnum -> Confirmation then contractualDefinitionsType
  is absent and contractualTermsSupplement is absent and contractualMatrix is absent'
- 'Rosetta condition: CreditSupportAgreement — if agreementType = LegalAgreementTypeEnum
  -> CreditSupportAgreement then creditSupportAgreementType exists'
- 'Rosetta condition: MasterConfirmation — if masterConfirmationAnnexType exists then
  masterConfirmationType exists'
- 'Rosetta condition: CSAMarginType — if creditSupportAgreementMarginType exists then
  creditSupportAgreementType exists'
in_subset:
- cdm_legaldocumentation_common
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:AgreementName
slots:
- agreementType
- creditSupportAgreementType
- creditSupportAgreementMarginType
- contractualDefinitionsType
- contractualTermsSupplement
- contractualMatrix
- masterAgreementType
- masterConfirmationType
- masterConfirmationAnnexType
- otherAgreement
- brokerConfirmationType
rules:
- preconditions:
    slot_conditions:
      agreementType:
        name: agreementType
        equals_string: CreditSupportAgreement
  postconditions:
    slot_conditions:
      creditSupportAgreementType:
        name: creditSupportAgreementType
        required: true
  description: A condition to ensure that the credit supoort agreement type is specified
    when required.
- preconditions:
    slot_conditions:
      masterConfirmationAnnexType:
        name: masterConfirmationAnnexType
        required: true
  postconditions:
    slot_conditions:
      masterConfirmationType:
        name: masterConfirmationType
        required: true
  description: If a master confirmation annex type is specified a master confirmation
    type must exist.
- preconditions:
    slot_conditions:
      creditSupportAgreementMarginType:
        name: creditSupportAgreementMarginType
        required: true
  postconditions:
    slot_conditions:
      creditSupportAgreementType:
        name: creditSupportAgreementType
        required: true
  description: A condition to ensure that CSA margin type is only specified if a credit
    support agreemnt type is specified.

Induced

name: AgreementName
description: Specifies the agreement name through an agreement type and optional detailed
  sub agreement type.
comments:
- 'Rosetta condition: AgreementType — if agreementType <> LegalAgreementTypeEnum ->
  Other then otherAgreement is absent else if agreementType <> LegalAgreementTypeEnum
  -> MasterAgreement then masterAgreementType is absent else if agreementType <> LegalAgreementTypeEnum
  -> MasterConfirmation then masterConfirmationType is absent and masterConfirmationAnnexType
  is absent else if agreementType <> LegalAgreementTypeEnum -> Confirmation then contractualDefinitionsType
  is absent and contractualTermsSupplement is absent and contractualMatrix is absent'
- 'Rosetta condition: CreditSupportAgreement — if agreementType = LegalAgreementTypeEnum
  -> CreditSupportAgreement then creditSupportAgreementType exists'
- 'Rosetta condition: MasterConfirmation — if masterConfirmationAnnexType exists then
  masterConfirmationType exists'
- 'Rosetta condition: CSAMarginType — if creditSupportAgreementMarginType exists then
  creditSupportAgreementType exists'
in_subset:
- cdm_legaldocumentation_common
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:AgreementName
attributes:
  agreementType:
    name: agreementType
    description: Specification of the legal agreement type.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AgreementName.agreementType
    rank: 1000
    owner: AgreementName
    domain_of:
    - AgreementName
    range: LegalAgreementTypeEnum
    required: true
  creditSupportAgreementType:
    name: creditSupportAgreementType
    annotations:
      metadata_scheme:
        tag: metadata_scheme
        value: true
    description: Specification of the credit support agreement type.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AgreementName.creditSupportAgreementType
    rank: 1000
    owner: AgreementName
    domain_of:
    - AgreementName
    range: CreditSupportAgreementTypeEnum
  creditSupportAgreementMarginType:
    name: creditSupportAgreementMarginType
    description: specifies the type of margin for which a legal agreement is named.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AgreementName.creditSupportAgreementMarginType
    rank: 1000
    owner: AgreementName
    domain_of:
    - AgreementName
    range: CollateralMarginTypeEnum
  contractualDefinitionsType:
    name: contractualDefinitionsType
    annotations:
      metadata_scheme:
        tag: metadata_scheme
        value: true
    description: The definitions such as those published by ISDA that will define
      the terms of the trade.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AgreementName.contractualDefinitionsType
    rank: 1000
    owner: AgreementName
    domain_of:
    - AgreementName
    range: ContractualDefinitionsEnum
    multivalued: true
  contractualTermsSupplement:
    name: contractualTermsSupplement
    description: A contractual supplement (such as those published by ISDA) that will
      apply to the trade.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AgreementName.contractualTermsSupplement
    rank: 1000
    owner: AgreementName
    domain_of:
    - AgreementName
    range: ContractualTermsSupplement
    multivalued: true
    inlined: true
    inlined_as_list: true
  contractualMatrix:
    name: contractualMatrix
    description: A reference to a contractual matrix of elected terms/values (such
      as those published by ISDA) that shall be deemed to apply to the trade. The
      applicable matrix is identified by reference to a name and optionally a publication
      date. Depending on the structure of the matrix, an additional term (specified
      in the matrixTerm element) may be required to further identify a subset of applicable
      terms/values within the matrix.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AgreementName.contractualMatrix
    rank: 1000
    owner: AgreementName
    domain_of:
    - AgreementName
    range: ContractualMatrix
    multivalued: true
    inlined: true
    inlined_as_list: true
  masterAgreementType:
    name: masterAgreementType
    annotations:
      metadata_scheme:
        tag: metadata_scheme
        value: true
    description: Specification of the master agreement type.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AgreementName.masterAgreementType
    rank: 1000
    owner: AgreementName
    domain_of:
    - AgreementName
    range: MasterAgreementTypeEnum
  masterConfirmationType:
    name: masterConfirmationType
    annotations:
      metadata_scheme:
        tag: metadata_scheme
        value: true
    description: The type of master confirmation executed between the parties.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AgreementName.masterConfirmationType
    rank: 1000
    owner: AgreementName
    domain_of:
    - AgreementName
    range: MasterConfirmationTypeEnum
  masterConfirmationAnnexType:
    name: masterConfirmationAnnexType
    annotations:
      metadata_scheme:
        tag: metadata_scheme
        value: true
    description: The type of master confirmation annex executed between the parties.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AgreementName.masterConfirmationAnnexType
    rank: 1000
    owner: AgreementName
    domain_of:
    - AgreementName
    range: MasterConfirmationAnnexTypeEnum
  otherAgreement:
    name: otherAgreement
    description: Definition of an agreement that is not enumerated in the CDM.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AgreementName.otherAgreement
    rank: 1000
    owner: AgreementName
    domain_of:
    - AgreementName
    range: string
  brokerConfirmationType:
    name: brokerConfirmationType
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AgreementName.brokerConfirmationType
    rank: 1000
    owner: AgreementName
    domain_of:
    - AgreementName
    - BrokerConfirmation
    range: BrokerConfirmationTypeEnum
rules:
- preconditions:
    slot_conditions:
      agreementType:
        name: agreementType
        equals_string: CreditSupportAgreement
  postconditions:
    slot_conditions:
      creditSupportAgreementType:
        name: creditSupportAgreementType
        required: true
  description: A condition to ensure that the credit supoort agreement type is specified
    when required.
- preconditions:
    slot_conditions:
      masterConfirmationAnnexType:
        name: masterConfirmationAnnexType
        required: true
  postconditions:
    slot_conditions:
      masterConfirmationType:
        name: masterConfirmationType
        required: true
  description: If a master confirmation annex type is specified a master confirmation
    type must exist.
- preconditions:
    slot_conditions:
      creditSupportAgreementMarginType:
        name: creditSupportAgreementMarginType
        required: true
  postconditions:
    slot_conditions:
      creditSupportAgreementType:
        name: creditSupportAgreementType
        required: true
  description: A condition to ensure that CSA margin type is only specified if a credit
    support agreemnt type is specified.