Class: AssetFlowBase

Defines the basic parameters of an asset transfer, e.g. a cashflow: what (the asset), how much (the quantity) and when (the settlement date).

URI: common_domain_model:AssetFlowBase

 classDiagram
    class AssetFlowBase
    click AssetFlowBase href "../AssetFlowBase/"
      AssetFlowBase <|-- TransferBase
        click TransferBase href "../TransferBase/"
      AssetFlowBase <|-- AssetFlow
        click AssetFlow href "../AssetFlow/"

      AssetFlowBase : asset





        AssetFlowBase --> "1" Asset : asset
        click Asset href "../Asset/"



      AssetFlowBase : paymentDiscounting





        AssetFlowBase --> "0..1" PaymentDiscounting : paymentDiscounting
        click PaymentDiscounting href "../PaymentDiscounting/"



      AssetFlowBase : quantity





        AssetFlowBase --> "1" NonNegativeQuantity : quantity
        click NonNegativeQuantity href "../NonNegativeQuantity/"



      AssetFlowBase : settlementDate





        AssetFlowBase --> "1" AdjustableOrAdjustedOrRelativeDate : settlementDate
        click AdjustableOrAdjustedOrRelativeDate href "../AdjustableOrAdjustedOrRelativeDate/"

Inheritance

AssetFlowBase
- TransferBase
- AssetFlow

Slots

Name	Cardinality and Range	Description	Inheritance
quantity	1 NonNegativeQuantity	Represents the amount of the asset to be transferred	direct
asset	1 Asset or Cash or Commodity or DigitalAsset or Instrument	Represents the object that is subject to the transfer, it could be an asset o...	direct
settlementDate	1 AdjustableOrAdjustedOrRelativeDate	Represents the date on which the transfer to due	direct
paymentDiscounting	0..1 PaymentDiscounting	FpML specifies the FpML PaymentDiscounting	direct

In Subsets

CdmProductCommonSettlement

Comments

Rosetta condition: QuantityUnitExists — if asset -> Cash exists then quantity -> unit -> currency exists else if asset -> Commodity exists then quantity -> unit -> capacityUnit exists else if asset -> Instrument exists then quantity -> unit -> financialUnit 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:AssetFlowBase
native	common_domain_model:AssetFlowBase
close	fpml_5_10:AssetFlowBase

LinkML Source

Direct

name: AssetFlowBase
description: 'Defines the basic parameters of an asset transfer, e.g. a cashflow:
  what (the asset), how much (the quantity) and when (the settlement date).'
comments:
- 'Rosetta condition: QuantityUnitExists — if asset -> Cash exists then quantity ->
  unit -> currency exists else if asset -> Commodity exists then quantity -> unit
  -> capacityUnit exists else if asset -> Instrument exists then quantity -> unit
  -> financialUnit exists'
in_subset:
- cdm_product_common_settlement
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:AssetFlowBase
slots:
- quantity
- asset
- settlementDate
- paymentDiscounting
slot_usage:
  quantity:
    name: quantity
    description: Represents the amount of the asset to be transferred. The cashflow
      amount is always a positive number, as the cashflow direction is implied by
      the payer/receiver attribute.
    range: NonNegativeQuantity
    required: true
  asset:
    name: asset
    description: Represents the object that is subject to the transfer, it could be
      an asset or a reference.
    required: true
  settlementDate:
    name: settlementDate
    description: Represents the date on which the transfer to due.
    range: AdjustableOrAdjustedOrRelativeDate

Induced

name: AssetFlowBase
description: 'Defines the basic parameters of an asset transfer, e.g. a cashflow:
  what (the asset), how much (the quantity) and when (the settlement date).'
comments:
- 'Rosetta condition: QuantityUnitExists — if asset -> Cash exists then quantity ->
  unit -> currency exists else if asset -> Commodity exists then quantity -> unit
  -> capacityUnit exists else if asset -> Instrument exists then quantity -> unit
  -> financialUnit exists'
in_subset:
- cdm_product_common_settlement
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:AssetFlowBase
slot_usage:
  quantity:
    name: quantity
    description: Represents the amount of the asset to be transferred. The cashflow
      amount is always a positive number, as the cashflow direction is implied by
      the payer/receiver attribute.
    range: NonNegativeQuantity
    required: true
  asset:
    name: asset
    description: Represents the object that is subject to the transfer, it could be
      an asset or a reference.
    required: true
  settlementDate:
    name: settlementDate
    description: Represents the date on which the transfer to due.
    range: AdjustableOrAdjustedOrRelativeDate
attributes:
  quantity:
    name: quantity
    description: Represents the amount of the asset to be transferred. The cashflow
      amount is always a positive number, as the cashflow direction is implied by
      the payer/receiver attribute.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CalculateTransferInstruction.quantity
    rank: 1000
    owner: AssetFlowBase
    domain_of:
    - CalculateTransferInstruction
    - ReturnInstruction
    - AvailableInventoryRecord
    - PriceQuantity
    - BasketConstituent
    - FutureValueAmount
    - AssetFlowBase
    - PortfolioReturnTerms
    range: NonNegativeQuantity
    required: true
  asset:
    name: asset
    description: Represents the object that is subject to the transfer, it could be
      an asset or a reference.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: AssetFlowBase
    domain_of:
    - PositionBase
    - AssetFlowBase
    range: Asset
    required: true
    any_of:
    - range: Cash
    - range: Commodity
    - range: DigitalAsset
    - range: Instrument
  settlementDate:
    name: settlementDate
    description: Represents the date on which the transfer to due.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:BillingRecordInstruction.settlementDate
    rank: 1000
    owner: AssetFlowBase
    domain_of:
    - BillingRecordInstruction
    - NonDeliverableSubstitute
    - AssetFlowBase
    - SettlementBase
    - AssetLeg
    range: AdjustableOrAdjustedOrRelativeDate
    required: true
  paymentDiscounting:
    name: paymentDiscounting
    description: FpML specifies the FpML PaymentDiscounting.model group for representing
      the discounting elements that can be associated with a payment.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetFlowBase.paymentDiscounting
    rank: 1000
    owner: AssetFlowBase
    domain_of:
    - AssetFlowBase
    range: PaymentDiscounting