Class: CreditDefaultPayout

name: CreditDefaultPayout
description: ' The credit default payout specification provides the details necessary
  for determining when a credit payout will be triggered as well as the parameters
  for calculating the payout and the settlement terms. The associated globalKey denotes
  the ability to associate a hash value to the CreditDefaultPayout instantiations
  for the purpose of model cross-referencing, in support of functionality such as
  the event effect and the lineage.'
comments:
- 'Rosetta condition: FpML_cd_12 — if generalTerms -> referenceInformation -> referencePrice
  exists then generalTerms -> referenceInformation -> referencePrice -> value >= 0'
- 'Rosetta condition: Quantity — priceQuantity exists'
in_subset:
- cdm_product_asset
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: PayoutBase
slots:
- generalTerms
- protectionTerms
- transactedPrice
rules:
- postconditions:
    slot_conditions:
      priceQuantity:
        name: priceQuantity
        required: true
  description: When there is an OptionPayout the quantity can be expressed as part
    of the payoutQuantity, or as part of the underlier in the case of a Swaption.  For
    all other payouts that extend PayoutBase the payoutQuantity is a mandatory attribute.

name: CreditDefaultPayout
description: ' The credit default payout specification provides the details necessary
  for determining when a credit payout will be triggered as well as the parameters
  for calculating the payout and the settlement terms. The associated globalKey denotes
  the ability to associate a hash value to the CreditDefaultPayout instantiations
  for the purpose of model cross-referencing, in support of functionality such as
  the event effect and the lineage.'
comments:
- 'Rosetta condition: FpML_cd_12 — if generalTerms -> referenceInformation -> referencePrice
  exists then generalTerms -> referenceInformation -> referencePrice -> value >= 0'
- 'Rosetta condition: Quantity — priceQuantity exists'
in_subset:
- cdm_product_asset
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: PayoutBase
attributes:
  generalTerms:
    name: generalTerms
    description: The specification of the non-monetary terms for the Credit Derivative
      Transaction, including the buyer and seller and selected items from the ISDA
      2014 Credit Definition article II, such as the reference obligation and related
      terms.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CreditDefaultPayout
    domain_of:
    - CreditDefaultPayout
    range: GeneralTerms
    required: true
  protectionTerms:
    name: protectionTerms
    description: Specifies the terms for calculating a payout to protect the buyer
      of the swap in the case of a qualified credit event. These terms include the
      applicable credit events, the reference obligation, and in the case of a CDS
      on mortgage-backed securities, the floatingAmountEvents.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CreditDefaultPayout
    domain_of:
    - CreditDefaultPayout
    range: ProtectionTerms
    multivalued: true
    inlined: true
    inlined_as_list: true
  transactedPrice:
    name: transactedPrice
    description: The qualification of the price at which the contract has been transacted,
      in terms of market fixed rate, initial points, market price and/or quotation
      style. In FpML, those attributes are positioned as part of the fee leg.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CreditDefaultPayout
    domain_of:
    - CreditDefaultPayout
    range: TransactedPrice
  payerReceiver:
    name: payerReceiver
    description: Canonical representation of the payer and receiver parties applicable
      to each payout leg.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CalculateTransferInstruction.payerReceiver
    rank: 1000
    owner: CreditDefaultPayout
    domain_of:
    - CalculateTransferInstruction
    - TransferBase
    - CollateralBalance
    - FeaturePayment
    - AssetFlow
    - PayoutBase
    - PrincipalPayment
    - PortfolioReturnTerms
    - PassThroughItem
    range: PayerReceiver
    required: true
  priceQuantity:
    name: priceQuantity
    description: Each payout leg must implement the quantity concept as a 'resolvable'
      type, which allows for different payout legs to be linked to each other (e.g.
      in the case of cross-curreny products).
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CreditDefaultPayout
    domain_of:
    - ExecutionInstruction
    - IndexTransitionInstruction
    - PositionBase
    - PayoutBase
    - TradeLot
    range: ResolvablePriceQuantity
    required: false
    multivalued: false
    inlined: true
    inlined_as_list: true
  principalPayment:
    name: principalPayment
    description: The specification of the principal exchange. Optional as only applicable
      in the case of cross-currency or zero-coupon swaps with a final payment.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CreditDefaultPayout
    domain_of:
    - PayoutBase
    range: PrincipalPayments
  settlementTerms:
    name: settlementTerms
    description: Each payout leg must specifies its settlement terms, including the
      delivery type (i.e. cash vs physical, and their respective terms), the transfer
      type (DvP etc.) and settlement date, if any.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CreditDefaultPayout
    domain_of:
    - EquitySwapMasterConfirmation2018
    - PayoutBase
    range: SettlementTerms
    required: false
rules:
- postconditions:
    slot_conditions:
      priceQuantity:
        name: priceQuantity
        required: true
  description: When there is an OptionPayout the quantity can be expressed as part
    of the payoutQuantity, or as part of the underlier in the case of a Swaption.  For
    all other payouts that extend PayoutBase the payoutQuantity is a mandatory attribute.