Class: CollateralPosition

Specifies the individual components of collateral positions.

URI: common_domain_model:CollateralPosition

 classDiagram
    class CollateralPosition
    click CollateralPosition href "../CollateralPosition/"
      PositionBase <|-- CollateralPosition
        click PositionBase href "../PositionBase/"
      
      CollateralPosition : asset
        
          
    
        
        
        CollateralPosition --> "0..1" Asset : asset
        click Asset href "../Asset/"
    

        
      CollateralPosition : cashBalance
        
          
    
        
        
        CollateralPosition --> "0..1" Money : cashBalance
        click Money href "../Money/"
    

        
      CollateralPosition : collateralPositionStatus
        
          
    
        
        
        CollateralPosition --> "0..1" CollateralStatusEnum : collateralPositionStatus
        click CollateralStatusEnum href "../CollateralStatusEnum/"
    

        
      CollateralPosition : priceQuantity
        
          
    
        
        
        CollateralPosition --> "1..*" PriceQuantity : priceQuantity
        click PriceQuantity href "../PriceQuantity/"
    

        
      CollateralPosition : product
        
          
    
        
        
        CollateralPosition --> "0..1" Product : product
        click Product href "../Product/"
    

        
      CollateralPosition : tradeReference
        
          
    
        
        
        CollateralPosition --> "0..1" TradeState : tradeReference
        click TradeState href "../TradeState/"
    

        
      CollateralPosition : treatment
        
          
    
        
        
        CollateralPosition --> "0..1" CollateralTreatment : treatment
        click CollateralTreatment href "../CollateralTreatment/"

Inheritance

PositionBase
- CollateralPosition

Slots

Name	Cardinality and Range	Description	Inheritance
treatment	0..1 CollateralTreatment	Specifies if there is any treatment to be applied to collateral, such as perc…	direct
collateralPositionStatus	0..1 CollateralStatusEnum	Indicates the collateral positions settlement status	direct
priceQuantity	1..* PriceQuantity	Position with many price quantities	PositionBase
product	0..1 Product	The product underlying the position	PositionBase
asset	0..1 Asset	The asset that underlies the position	PositionBase
cashBalance	0..1 Money	The aggregate cost of proceeds	PositionBase
tradeReference	0..1 TradeState	Reference to the Contract, in case product is contractual and the contract ha…	PositionBase

Expressions & Logic

All Of

The class must satisfy all of:

AnonymousClassExpression({ ‘description’: (’From PositionBase. ProductOrAsset: A Position must either refer to a ’ ‘grouping by product or a grouping by asset.’), ‘exactly_one_of’: [AnonymousClassExpression({ ‘slot_conditions’: {‘product’: SlotDefinition({‘name’: ‘product’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} }), AnonymousClassExpression({ ‘slot_conditions’: {‘asset’: SlotDefinition({‘name’: ‘asset’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} })] })

Usages

used by	used in	type	used
CollateralPortfolio	collateralPosition	range	CollateralPosition
MarginCallResponseAction	collateralPositionComponent	range	CollateralPosition

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	`{'collateralPositionStatus': {'value_presence': 'PRESENT'}}`
any_of		`[{'slot_conditions': {'collateralPositionStatus': {'value_presence': 'PRESENT', 'equals_string': 'SettledAmount'}}}, {'slot_conditions': {'collateralPositionStatus': {'value_presence': 'PRESENT', 'equals_string': 'InTransitAmount'}}}]`

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: CollateralPosition
description: Specifies the individual components of collateral positions.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: PositionBase
attributes:
  treatment:
    name: treatment
    description: Specifies if there is any treatment to be applied to collateral,
      such as percentage discount which will impact collateral value.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - CollateralPosition
    - FloatingRateProcessingParameters
    - EligibleCollateralCriteria
    range: CollateralTreatment
  collateralPositionStatus:
    name: collateralPositionStatus
    description: Indicates the collateral positions settlement status.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - CollateralPosition
    range: CollateralStatusEnum
rules:
- preconditions:
    slot_conditions:
      collateralPositionStatus:
        name: collateralPositionStatus
        value_presence: PRESENT
  postconditions:
    any_of:
    - slot_conditions:
        collateralPositionStatus:
          name: collateralPositionStatus
          value_presence: PRESENT
          equals_string: SettledAmount
    - slot_conditions:
        collateralPositionStatus:
          name: collateralPositionStatus
          value_presence: PRESENT
          equals_string: InTransitAmount
  description: 'CollateralPositionStatusSettledOrInTransitOnly: Represents a condition
    to ensure that if a status is defined for a collateral position you must only
    indicate ''Settled Amount'' or ''In Transit'' amount from the available enumerations.'
all_of:
- description: 'From PositionBase. ProductOrAsset: A Position must either refer to
    a grouping by product or a grouping by asset.'
  exactly_one_of:
  - slot_conditions:
      product:
        name: product
        value_presence: PRESENT
  - slot_conditions:
      asset:
        name: asset
        value_presence: PRESENT

Induced

name: CollateralPosition
description: Specifies the individual components of collateral positions.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: PositionBase
attributes:
  treatment:
    name: treatment
    description: Specifies if there is any treatment to be applied to collateral,
      such as percentage discount which will impact collateral value.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: CollateralPosition
    domain_of:
    - CollateralPosition
    - FloatingRateProcessingParameters
    - EligibleCollateralCriteria
    range: CollateralTreatment
  collateralPositionStatus:
    name: collateralPositionStatus
    description: Indicates the collateral positions settlement status.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: CollateralPosition
    domain_of:
    - CollateralPosition
    range: CollateralStatusEnum
  priceQuantity:
    name: priceQuantity
    description: Position with many price quantities.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    owner: CollateralPosition
    domain_of:
    - ExecutionInstruction
    - IndexTransitionInstruction
    - PositionBase
    - PayoutBase
    - TradeLot
    range: PriceQuantity
    required: true
    multivalued: true
  product:
    name: product
    description: The product underlying the position.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    owner: CollateralPosition
    domain_of:
    - ExecutionInstruction
    - TermsChangeInstruction
    - AggregationParameters
    - PositionBase
    - ExcludedProducts
    - TradableProduct
    range: Product
  asset:
    name: asset
    description: The asset that underlies the position.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    owner: CollateralPosition
    domain_of:
    - TransferBase
    - PositionBase
    - TransferableProduct
    range: Asset
  cashBalance:
    name: cashBalance
    description: The aggregate cost of proceeds.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    owner: CollateralPosition
    domain_of:
    - PositionBase
    range: Money
  tradeReference:
    name: tradeReference
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: reference
    description: Reference to the Contract, in case product is contractual and the
      contract has been formed.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    owner: CollateralPosition
    domain_of:
    - Lineage
    - AggregationParameters
    - CounterpartyPosition
    - PositionBase
    range: TradeState
rules:
- preconditions:
    slot_conditions:
      collateralPositionStatus:
        name: collateralPositionStatus
        value_presence: PRESENT
  postconditions:
    any_of:
    - slot_conditions:
        collateralPositionStatus:
          name: collateralPositionStatus
          value_presence: PRESENT
          equals_string: SettledAmount
    - slot_conditions:
        collateralPositionStatus:
          name: collateralPositionStatus
          value_presence: PRESENT
          equals_string: InTransitAmount
  description: 'CollateralPositionStatusSettledOrInTransitOnly: Represents a condition
    to ensure that if a status is defined for a collateral position you must only
    indicate ''Settled Amount'' or ''In Transit'' amount from the available enumerations.'
all_of:
- description: 'From PositionBase. ProductOrAsset: A Position must either refer to
    a grouping by product or a grouping by asset.'
  exactly_one_of:
  - slot_conditions:
      product:
        name: product
        value_presence: PRESENT
  - slot_conditions:
      asset:
        name: asset
        value_presence: PRESENT