Class: ReturnInstruction

Specifies the information required to create the return of a Security Finance Transaction.

URI: common_domain_model:ReturnInstruction

 classDiagram
    class ReturnInstruction
    click ReturnInstruction href "../ReturnInstruction/"
      ReturnInstruction : quantity





        ReturnInstruction --> "1..*" Quantity : quantity
        click Quantity href "../Quantity/"

Slots

Name	Cardinality and Range	Description	Inheritance
quantity	1..* Quantity	Specifies the quantity of shares and cash to be returned in a partial return ...	direct

In Subsets

CdmEventCommon

Comments

Rosetta func: Create_Return — Defines the process of partially or fully returning a Security Lending Transaction.

Identifier and Mapping Information

Annotations

property

value

rosetta_functions

[{"name":"Create_Return","description":"Defines the process of partially or fully returning a Security Lending Transaction.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"1..1"},{"name":"returnInstruction","type":"ReturnInstruction","cardinality":"1..1"},{"name":"returnDate","type":"date","cardinality":"1..1"}],"output":{"name":"returnEvent","type":"BusinessEvent","cardinality":"1..1"}}]

Schema Source

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

Mappings

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

LinkML Source

Direct

name: ReturnInstruction
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_Return","description":"Defines the process of partially
      or fully returning a Security Lending Transaction.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"1..1"},{"name":"returnInstruction","type":"ReturnInstruction","cardinality":"1..1"},{"name":"returnDate","type":"date","cardinality":"1..1"}],"output":{"name":"returnEvent","type":"BusinessEvent","cardinality":"1..1"}}]'
description: Specifies the information required to create the return of a Security
  Finance Transaction.
comments:
- 'Rosetta func: Create_Return — Defines the process of partially or fully returning
  a Security Lending Transaction.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- quantity
slot_usage:
  quantity:
    name: quantity
    description: Specifies the quantity of shares and cash to be returned in a partial
      return event.
    required: true
    multivalued: true

Induced

name: ReturnInstruction
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_Return","description":"Defines the process of partially
      or fully returning a Security Lending Transaction.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"1..1"},{"name":"returnInstruction","type":"ReturnInstruction","cardinality":"1..1"},{"name":"returnDate","type":"date","cardinality":"1..1"}],"output":{"name":"returnEvent","type":"BusinessEvent","cardinality":"1..1"}}]'
description: Specifies the information required to create the return of a Security
  Finance Transaction.
comments:
- 'Rosetta func: Create_Return — Defines the process of partially or fully returning
  a Security Lending Transaction.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
slot_usage:
  quantity:
    name: quantity
    description: Specifies the quantity of shares and cash to be returned in a partial
      return event.
    required: true
    multivalued: true
attributes:
  quantity:
    name: quantity
    description: Specifies the quantity of shares and cash to be returned in a partial
      return event.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CalculateTransferInstruction.quantity
    rank: 1000
    owner: ReturnInstruction
    domain_of:
    - CalculateTransferInstruction
    - ReturnInstruction
    - AvailableInventoryRecord
    - PriceQuantity
    - BasketConstituent
    - FutureValueAmount
    - AssetFlowBase
    - PortfolioReturnTerms
    range: Quantity
    required: true
    multivalued: true