Class: State

Defines the state of a trade at a point in the Trade's life cycle. Trades have many state dimensions, all of which are represented here. For example, states useful for position keeping are represented alongside those needed for regulatory reporting.

URI: common_domain_model:State

 classDiagram
    class State
    click State href "../State/"
      State : closedState





        State --> "0..1" ClosedState : closedState
        click ClosedState href "../ClosedState/"



      State : positionState





        State --> "0..1" PositionStatusEnum : positionState
        click PositionStatusEnum href "../PositionStatusEnum/"

Slots

Name	Cardinality and Range	Description	Inheritance
closedState	0..1 ClosedState	Represents the qualification of what led to the trade's closure alongside the...	direct
positionState	0..1 PositionStatusEnum	Identifies the state of the position, to distinguish if just executed, formed...	direct

Usages

used by	used in	type	used
TradeState	state	range	State
CounterpartyPositionState	state	range	State

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	`{'positionState': {'equals_string': 'Closed'}}`	`{'closedState': {'required': True}}`

In Subsets

CdmEventCommon

Comments

Rosetta condition: ClosedStateExists — if positionState = PositionStatusEnum -> Closed then closedState 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:State
native	common_domain_model:State

LinkML Source

Direct

name: State
description: Defines the state of a trade at a point in the Trade's life cycle. Trades
  have many state dimensions, all of which are represented here. For example, states
  useful for position keeping are represented alongside those needed for regulatory
  reporting.
comments:
- 'Rosetta condition: ClosedStateExists — if positionState = PositionStatusEnum ->
  Closed then closedState exists'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- closedState
- positionState
rules:
- preconditions:
    slot_conditions:
      positionState:
        name: positionState
        equals_string: Closed
  postconditions:
    slot_conditions:
      closedState:
        name: closedState
        required: true
  description: When the position state is identified as closed, the closed state must
    also be specified.

Induced

name: State
description: Defines the state of a trade at a point in the Trade's life cycle. Trades
  have many state dimensions, all of which are represented here. For example, states
  useful for position keeping are represented alongside those needed for regulatory
  reporting.
comments:
- 'Rosetta condition: ClosedStateExists — if positionState = PositionStatusEnum ->
  Closed then closedState exists'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  closedState:
    name: closedState
    description: Represents the qualification of what led to the trade's closure alongside
      the dates on which this closure took effect.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: State
    domain_of:
    - State
    range: ClosedState
  positionState:
    name: positionState
    description: Identifies the state of the position, to distinguish if just executed,
      formed, already settled, closed, etc.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: State
    domain_of:
    - State
    range: PositionStatusEnum
rules:
- preconditions:
    slot_conditions:
      positionState:
        name: positionState
        equals_string: Closed
  postconditions:
    slot_conditions:
      closedState:
        name: closedState
        required: true
  description: When the position state is identified as closed, the closed state must
    also be specified.