Skip to content

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 or 
AssetPayout or 
CommodityPayout or 
CreditDefaultPayout or 
FixedPricePayout or 
InterestRatePayout or 
OptionPayout or 
PerformancePayout or 
SettlementPayout		 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

In Subsets

Comments

  • Rosetta func: CalculateTransfer — Function specification to calculate a transfer, e.g. following a reset on a contract
  • Rosetta func: Create_CashTransfer — Defines how Transfer that represents an exchange of cash, should be constructed.
  • Rosetta func: Create_AssetTransfer — Defines how Transfer that represents an exchange of asset based on an asset payout, should be constructed.
  • Rosetta func: ResolveTransfer — Defines how to calculate the amount due to be transferred after a Reset Event.

Identifier and Mapping Information

Annotations

property value
rosetta_functions [{"name":"CalculateTransfer","description":"Function specification to calculate a transfer, e.g. following a reset on a contract","inputs":[{"name":"instruction","type":"CalculateTransferInstruction","cardinality":"1..1"}],"output":{"name":"transfer","type":"Transfer","cardinality":"0..*"}},{"name":"Create_CashTransfer","description":"Defines how Transfer that represents an exchange of cash, should be constructed.","inputs":[{"name":"instruction","type":"CalculateTransferInstruction","cardinality":"1..1"}],"output":{"name":"transfer","type":"Transfer","cardinality":"1..1"}},{"name":"Create_AssetTransfer","description":"Defines how Transfer that represents an exchange of asset based on an asset payout, should be constructed.","inputs":[{"name":"instruction","type":"CalculateTransferInstruction","cardinality":"1..1"}],"output":{"name":"transfer","type":"Transfer","cardinality":"1..1"}},{"name":"ResolveTransfer","description":"Defines how to calculate the amount due to be transferred after a Reset Event.","inputs":[{"name":"instruction","type":"CalculateTransferInstruction","cardinality":"1..1"}],"output":{"name":"transfer","type":"Transfer","cardinality":"1..1"}}]

Schema Source

Mappings

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

LinkML Source

Direct

name: CalculateTransferInstruction
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"CalculateTransfer","description":"Function specification to
      calculate a transfer, e.g. following a reset on a contract","inputs":[{"name":"instruction","type":"CalculateTransferInstruction","cardinality":"1..1"}],"output":{"name":"transfer","type":"Transfer","cardinality":"0..*"}},{"name":"Create_CashTransfer","description":"Defines
      how Transfer that represents an exchange of cash, should be constructed.","inputs":[{"name":"instruction","type":"CalculateTransferInstruction","cardinality":"1..1"}],"output":{"name":"transfer","type":"Transfer","cardinality":"1..1"}},{"name":"Create_AssetTransfer","description":"Defines
      how Transfer that represents an exchange of asset based on an asset payout,
      should be constructed.","inputs":[{"name":"instruction","type":"CalculateTransferInstruction","cardinality":"1..1"}],"output":{"name":"transfer","type":"Transfer","cardinality":"1..1"}},{"name":"ResolveTransfer","description":"Defines
      how to calculate the amount due to be transferred after a Reset Event.","inputs":[{"name":"instruction","type":"CalculateTransferInstruction","cardinality":"1..1"}],"output":{"name":"transfer","type":"Transfer","cardinality":"1..1"}}]'
description: Defines the tradeState or payout on which to create a Transfer along
  with all necessary resets.
comments:
- 'Rosetta func: CalculateTransfer — Function specification to calculate a transfer,
  e.g. following a reset on a contract'
- 'Rosetta func: Create_CashTransfer — Defines how Transfer that represents an exchange
  of cash, should be constructed.'
- 'Rosetta func: Create_AssetTransfer — Defines how Transfer that represents an exchange
  of asset based on an asset payout, should be constructed.'
- 'Rosetta func: ResolveTransfer — Defines how to calculate the amount due to be transferred
  after a Reset Event.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:CalculateTransferInstruction
slots:
- tradeState
- payout
- resets
- payerReceiver
- quantity
- date
slot_usage:
  payout:
    name: payout
    multivalued: false
  date:
    name: date
    required: false
    multivalued: false

Induced

name: CalculateTransferInstruction
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"CalculateTransfer","description":"Function specification to
      calculate a transfer, e.g. following a reset on a contract","inputs":[{"name":"instruction","type":"CalculateTransferInstruction","cardinality":"1..1"}],"output":{"name":"transfer","type":"Transfer","cardinality":"0..*"}},{"name":"Create_CashTransfer","description":"Defines
      how Transfer that represents an exchange of cash, should be constructed.","inputs":[{"name":"instruction","type":"CalculateTransferInstruction","cardinality":"1..1"}],"output":{"name":"transfer","type":"Transfer","cardinality":"1..1"}},{"name":"Create_AssetTransfer","description":"Defines
      how Transfer that represents an exchange of asset based on an asset payout,
      should be constructed.","inputs":[{"name":"instruction","type":"CalculateTransferInstruction","cardinality":"1..1"}],"output":{"name":"transfer","type":"Transfer","cardinality":"1..1"}},{"name":"ResolveTransfer","description":"Defines
      how to calculate the amount due to be transferred after a Reset Event.","inputs":[{"name":"instruction","type":"CalculateTransferInstruction","cardinality":"1..1"}],"output":{"name":"transfer","type":"Transfer","cardinality":"1..1"}}]'
description: Defines the tradeState or payout on which to create a Transfer along
  with all necessary resets.
comments:
- 'Rosetta func: CalculateTransfer — Function specification to calculate a transfer,
  e.g. following a reset on a contract'
- 'Rosetta func: Create_CashTransfer — Defines how Transfer that represents an exchange
  of cash, should be constructed.'
- 'Rosetta func: Create_AssetTransfer — Defines how Transfer that represents an exchange
  of asset based on an asset payout, should be constructed.'
- 'Rosetta func: ResolveTransfer — Defines how to calculate the amount due to be transferred
  after a Reset Event.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:CalculateTransferInstruction
slot_usage:
  payout:
    name: payout
    multivalued: false
  date:
    name: date
    required: false
    multivalued: false
attributes:
  tradeState:
    name: tradeState
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CalculateTransferInstruction.tradeState
    rank: 1000
    owner: CalculateTransferInstruction
    domain_of:
    - CalculateTransferInstruction
    - BillingRecordInstruction
    - BillingRecord
    range: TradeState
    required: true
  payout:
    name: payout
    annotations:
      metadata_reference:
        tag: metadata_reference
        value: true
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CalculateTransferInstruction
    domain_of:
    - ResetInstruction
    - CalculateTransferInstruction
    - EconomicTerms
    range: Payout
    required: true
    multivalued: false
    inlined: true
    inlined_as_list: true
    any_of:
    - range: AssetPayout
    - range: CommodityPayout
    - range: CreditDefaultPayout
    - range: FixedPricePayout
    - range: InterestRatePayout
    - range: OptionPayout
    - range: PerformancePayout
    - range: SettlementPayout
  resets:
    name: resets
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CalculateTransferInstruction.resets
    rank: 1000
    owner: CalculateTransferInstruction
    domain_of:
    - CalculateTransferInstruction
    range: Reset
    multivalued: true
    inlined: true
    inlined_as_list: true
  payerReceiver:
    name: payerReceiver
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CalculateTransferInstruction.payerReceiver
    rank: 1000
    owner: CalculateTransferInstruction
    domain_of:
    - CalculateTransferInstruction
    - TransferBase
    - CollateralBalance
    - FeaturePayment
    - AssetFlow
    - PayoutBase
    - PrincipalPayment
    - PortfolioReturnTerms
    - PassThroughItem
    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
    close_mappings:
    - fpml_5_10:CalculateTransferInstruction.quantity
    rank: 1000
    owner: CalculateTransferInstruction
    domain_of:
    - CalculateTransferInstruction
    - ReturnInstruction
    - AvailableInventoryRecord
    - PriceQuantity
    - BasketConstituent
    - FutureValueAmount
    - AssetFlowBase
    - PortfolioReturnTerms
    range: Quantity
  date:
    name: date
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CalculateTransferInstruction
    domain_of:
    - DateList
    - DatedValue
    - CalculateTransferInstruction
    - OtherAgreement
    - AmendmentEffectiveDate
    - CSAValuationDate
    range: date
    required: false
    multivalued: false