Skip to content

Class: TransferState

Defines the fundamental financial information associated with a Transfer event. Each TransferState specifies where a Transfer is in its life-cycle. TransferState is a root type and as such, can be created independently to any other CDM data type, but can also be used as part of the CDM Event Model.

URI: common_domain_model:TransferState

 classDiagram
    class TransferState
    click TransferState href "../TransferState/"
      TransferState : transfer





        TransferState --> "1" Transfer : transfer
        click Transfer href "../Transfer/"



      TransferState : transferStatus





        TransferState --> "0..1" TransferStatusEnum : transferStatus
        click TransferStatusEnum href "../TransferStatusEnum/"

Class Properties

Property Value
Tree Root Yes

Slots

Name Cardinality and Range Description Inheritance
transfer 1
Transfer		 Represents the Transfer that has been effected by a business or life-cycle ev... direct
transferStatus 0..1
TransferStatusEnum		 Represents the State of the Transfer through its life-cycle direct

Usages

used by used in type used
TransferInstruction transferState range TransferState
TradeState transferHistory range TransferState

In Subsets

Comments

  • Rosetta func: EmptyTransferHistory
  • Rosetta func: AssetPayoutObligationsFulfilled — Determines whether the obligations defined by the AssetPayout have been fulfilled by checking that the quantity of shares required have been successfully transferred.
  • Rosetta func: InterestPayoutObligationsFulfilled — Determines whether the obligations defined by the InterestRatePayout have been fulfilled by checking that the total value of cash required has been successfully transferred.

Identifier and Mapping Information

Annotations

property value
metadata_key True
rosetta_functions [{"name":"EmptyTransferHistory","output":{"name":"emptyTransferHistory","type":"TransferState","cardinality":"0.."},"code_implementation":true},{"name":"AssetPayoutObligationsFulfilled","description":"Determines whether the obligations defined by the AssetPayout have been fulfilled by checking that the quantity of shares required have been successfully transferred.","inputs":[{"name":"assetPayout","type":"AssetPayout","cardinality":"1..1"},{"name":"transferHistory","type":"TransferState","cardinality":"0.."}],"output":{"name":"isFulfilled","type":"boolean","cardinality":"1..1"}},{"name":"InterestPayoutObligationsFulfilled","description":"Determines whether the obligations defined by the InterestRatePayout have been fulfilled by checking that the total value of cash required has been successfully transferred.","inputs":[{"name":"interestRatePayout","type":"InterestRatePayout","cardinality":"1..1"},{"name":"transferHistory","type":"TransferState","cardinality":"0..*"}],"output":{"name":"isFulfilled","type":"boolean","cardinality":"1..1"}}]

Schema Source

Mappings

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

LinkML Source

Direct

name: TransferState
annotations:
  metadata_key:
    tag: metadata_key
    value: true
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"EmptyTransferHistory","output":{"name":"emptyTransferHistory","type":"TransferState","cardinality":"0..*"},"code_implementation":true},{"name":"AssetPayoutObligationsFulfilled","description":"Determines
      whether the obligations defined by the AssetPayout have been fulfilled by checking
      that the quantity of shares required have been successfully transferred.","inputs":[{"name":"assetPayout","type":"AssetPayout","cardinality":"1..1"},{"name":"transferHistory","type":"TransferState","cardinality":"0..*"}],"output":{"name":"isFulfilled","type":"boolean","cardinality":"1..1"}},{"name":"InterestPayoutObligationsFulfilled","description":"Determines
      whether the obligations defined by the InterestRatePayout have been fulfilled
      by checking that the total value of cash required has been successfully transferred.","inputs":[{"name":"interestRatePayout","type":"InterestRatePayout","cardinality":"1..1"},{"name":"transferHistory","type":"TransferState","cardinality":"0..*"}],"output":{"name":"isFulfilled","type":"boolean","cardinality":"1..1"}}]'
description: Defines the fundamental financial information associated with a Transfer
  event. Each TransferState specifies where a Transfer is in its life-cycle. TransferState
  is a root type and as such, can be created independently to any other CDM data type,
  but can also be used as part of the CDM Event Model.
comments:
- 'Rosetta func: EmptyTransferHistory'
- 'Rosetta func: AssetPayoutObligationsFulfilled — Determines whether the obligations
  defined by the AssetPayout have been fulfilled by checking that the quantity of
  shares required have been successfully transferred.'
- 'Rosetta func: InterestPayoutObligationsFulfilled — Determines whether the obligations
  defined by the InterestRatePayout have been fulfilled by checking that the total
  value of cash required has been successfully transferred.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- transfer
- transferStatus
slot_usage:
  transfer:
    name: transfer
    description: Represents the Transfer that has been effected by a business or life-cycle
      event.
    range: Transfer
    required: true
tree_root: true

Induced

name: TransferState
annotations:
  metadata_key:
    tag: metadata_key
    value: true
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"EmptyTransferHistory","output":{"name":"emptyTransferHistory","type":"TransferState","cardinality":"0..*"},"code_implementation":true},{"name":"AssetPayoutObligationsFulfilled","description":"Determines
      whether the obligations defined by the AssetPayout have been fulfilled by checking
      that the quantity of shares required have been successfully transferred.","inputs":[{"name":"assetPayout","type":"AssetPayout","cardinality":"1..1"},{"name":"transferHistory","type":"TransferState","cardinality":"0..*"}],"output":{"name":"isFulfilled","type":"boolean","cardinality":"1..1"}},{"name":"InterestPayoutObligationsFulfilled","description":"Determines
      whether the obligations defined by the InterestRatePayout have been fulfilled
      by checking that the total value of cash required has been successfully transferred.","inputs":[{"name":"interestRatePayout","type":"InterestRatePayout","cardinality":"1..1"},{"name":"transferHistory","type":"TransferState","cardinality":"0..*"}],"output":{"name":"isFulfilled","type":"boolean","cardinality":"1..1"}}]'
description: Defines the fundamental financial information associated with a Transfer
  event. Each TransferState specifies where a Transfer is in its life-cycle. TransferState
  is a root type and as such, can be created independently to any other CDM data type,
  but can also be used as part of the CDM Event Model.
comments:
- 'Rosetta func: EmptyTransferHistory'
- 'Rosetta func: AssetPayoutObligationsFulfilled — Determines whether the obligations
  defined by the AssetPayout have been fulfilled by checking that the quantity of
  shares required have been successfully transferred.'
- 'Rosetta func: InterestPayoutObligationsFulfilled — Determines whether the obligations
  defined by the InterestRatePayout have been fulfilled by checking that the total
  value of cash required has been successfully transferred.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
slot_usage:
  transfer:
    name: transfer
    description: Represents the Transfer that has been effected by a business or life-cycle
      event.
    range: Transfer
    required: true
attributes:
  transfer:
    name: transfer
    description: Represents the Transfer that has been effected by a business or life-cycle
      event.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: TransferState
    domain_of:
    - PrimitiveInstruction
    - TransferState
    range: Transfer
    required: true
  transferStatus:
    name: transferStatus
    description: Represents the State of the Transfer through its life-cycle.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: TransferState
    domain_of:
    - TransferState
    range: TransferStatusEnum
tree_root: true