Class: CalculateTransferInstruction

Defines the tradeState or payout on which to create a Transfer along with all necessary resets.

URI: common_domain_model:CalculateTransferInstruction

 classDiagram
    class CalculateTransferInstruction
    click CalculateTransferInstruction href "../CalculateTransferInstruction/"
      CalculateTransferInstruction : date
        
      CalculateTransferInstruction : payerReceiver
        
          
    
        
        
        CalculateTransferInstruction --> "0..1" PayerReceiver : payerReceiver
        click PayerReceiver href "../PayerReceiver/"
    

        
      CalculateTransferInstruction : payout
        
          
    
        
        
        CalculateTransferInstruction --> "1" Payout : payout
        click Payout href "../Payout/"
    

        
      CalculateTransferInstruction : quantity
        
          
    
        
        
        CalculateTransferInstruction --> "0..1" Quantity : quantity
        click Quantity href "../Quantity/"
    

        
      CalculateTransferInstruction : resets
        
          
    
        
        
        CalculateTransferInstruction --> "*" Reset : resets
        click Reset href "../Reset/"
    

        
      CalculateTransferInstruction : tradeState
        
          
    
        
        
        CalculateTransferInstruction --> "1" TradeState : tradeState
        click TradeState href "../TradeState/"
    

        
      

Slots

Name	Cardinality and Range	Description	Inheritance
tradeState	1 TradeState		direct
payout	1 Payout		direct
resets	* Reset		direct
payerReceiver	0..1 PayerReceiver		direct
quantity	0..1 Quantity	Specifies quantity amount returned if not the full amount from the TradeState…	direct
date	0..1 date		direct

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: CalculateTransferInstruction
description: Defines the tradeState or payout on which to create a Transfer along
  with all necessary resets.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  tradeState:
    name: tradeState
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    domain_of:
    - BillingRecord
    - BillingRecordInstruction
    - CalculateTransferInstruction
    range: TradeState
    required: true
  payout:
    name: payout
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: reference
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    domain_of:
    - CalculateResetInstruction
    - CalculateTransferInstruction
    - EconomicTerms
    range: Payout
    required: true
  resets:
    name: resets
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - CalculateTransferInstruction
    range: Reset
    multivalued: true
  payerReceiver:
    name: payerReceiver
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - CalculateTransferInstruction
    - CollateralBalance
    - PayoutTransferBase
    - FeaturePayment
    - PayoutBase
    - PrincipalPayment
    - PassThroughItem
    - PortfolioReturnTerms
    range: PayerReceiver
  quantity:
    name: quantity
    description: Specifies quantity amount returned if not the full amount from the
      TradeState, e.g. partial return
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - CalculateTransferInstruction
    - ReturnInstruction
    - TransferBase
    - BasketConstituent
    - PriceQuantity
    - AvailableInventoryRecord
    - FutureValueAmount
    - PortfolioReturnTerms
    range: Quantity
  date:
    name: date
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    domain_of:
    - DateList
    - DatedValue
    - CalculateTransferInstruction
    - OtherAgreement
    - AmendmentEffectiveDate
    - CSAValuationDate
    range: date

Induced

name: CalculateTransferInstruction
description: Defines the tradeState or payout on which to create a Transfer along
  with all necessary resets.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  tradeState:
    name: tradeState
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    owner: CalculateTransferInstruction
    domain_of:
    - BillingRecord
    - BillingRecordInstruction
    - CalculateTransferInstruction
    range: TradeState
    required: true
  payout:
    name: payout
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: reference
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    owner: CalculateTransferInstruction
    domain_of:
    - CalculateResetInstruction
    - CalculateTransferInstruction
    - EconomicTerms
    range: Payout
    required: true
  resets:
    name: resets
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: CalculateTransferInstruction
    domain_of:
    - CalculateTransferInstruction
    range: Reset
    multivalued: true
  payerReceiver:
    name: payerReceiver
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: CalculateTransferInstruction
    domain_of:
    - CalculateTransferInstruction
    - CollateralBalance
    - PayoutTransferBase
    - FeaturePayment
    - PayoutBase
    - PrincipalPayment
    - PassThroughItem
    - PortfolioReturnTerms
    range: PayerReceiver
  quantity:
    name: quantity
    description: Specifies quantity amount returned if not the full amount from the
      TradeState, e.g. partial return
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: CalculateTransferInstruction
    domain_of:
    - CalculateTransferInstruction
    - ReturnInstruction
    - TransferBase
    - BasketConstituent
    - PriceQuantity
    - AvailableInventoryRecord
    - FutureValueAmount
    - PortfolioReturnTerms
    range: Quantity
  date:
    name: date
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    owner: CalculateTransferInstruction
    domain_of:
    - DateList
    - DatedValue
    - CalculateTransferInstruction
    - OtherAgreement
    - AmendmentEffectiveDate
    - CSAValuationDate
    range: date