Class: IdentifiedList

Attaches an identifier to a collection of objects, when those objects themselves can each be represented by an identifier. One use case is the representation of package transactions, where each component is a separate trade with its own identifier, and those trades are linked together as a package with its own identifier. The data type has been named generically rather than referring to 'packages' as it may have a number of other uses.

URI: common_domain_model:IdentifiedList

 classDiagram
    class IdentifiedList
    click IdentifiedList href "../IdentifiedList/"
      IdentifiedList : componentId





        IdentifiedList --> "1..*" Identifier : componentId
        click Identifier href "../Identifier/"



      IdentifiedList : listId





        IdentifiedList --> "1" Identifier : listId
        click Identifier href "../Identifier/"



      IdentifiedList : price





        IdentifiedList --> "0..1" Price : price
        click Price href "../Price/"

Slots

Name	Cardinality and Range	Description	Inheritance
listId	1 Identifier	The identifier for the list	direct
componentId	1..* Identifier	Identifiers for each component of the list	direct
price	0..1 Price	The price of the package	direct

Usages

used by	used in	type	used
BusinessEvent	packageInformation	range	IdentifiedList
CounterpartyPositionBusinessEvent	packageInformation	range	IdentifiedList
ExecutionDetails	packageReference	range	IdentifiedList
EventInstruction	packageInformation	range	IdentifiedList

In Subsets

CdmBaseStaticdataIdentifier

Identifier and Mapping Information

Annotations

property	value
metadata_key	True

Schema Source

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

Mappings

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

LinkML Source

Direct

name: IdentifiedList
annotations:
  metadata_key:
    tag: metadata_key
    value: true
description: Attaches an identifier to a collection of objects, when those objects
  themselves can each be represented by an identifier. One use case is the representation
  of package transactions, where each component is a separate trade with its own identifier,
  and those trades are linked together as a package with its own identifier. The data
  type has been named generically rather than referring to 'packages' as it may have
  a number of other uses.
in_subset:
- cdm_base_staticdata_identifier
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- listId
- componentId
- price

Induced

name: IdentifiedList
annotations:
  metadata_key:
    tag: metadata_key
    value: true
description: Attaches an identifier to a collection of objects, when those objects
  themselves can each be represented by an identifier. One use case is the representation
  of package transactions, where each component is a separate trade with its own identifier,
  and those trades are linked together as a package with its own identifier. The data
  type has been named generically rather than referring to 'packages' as it may have
  a number of other uses.
in_subset:
- cdm_base_staticdata_identifier
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  listId:
    name: listId
    description: The identifier for the list. In the case of a package transaction,
      this would be the package identifier. This attribute is mandatory to allow the
      list itself to be identified.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: IdentifiedList
    domain_of:
    - IdentifiedList
    range: Identifier
    required: true
  componentId:
    name: componentId
    description: Identifiers for each component of the list. Since the data type is
      used to link multiple identified objects together, at least 2 components are
      required in the list. Creating an identified list with only 1 identified component
      has been deemed unnecessary, because it would just create a redundant identifier.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: IdentifiedList
    domain_of:
    - IdentifiedList
    range: Identifier
    required: true
    multivalued: true
    inlined: true
    inlined_as_list: true
  price:
    name: price
    description: The price of the package.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: IdentifiedList
    domain_of:
    - IdentifiedList
    - PriceQuantity
    - RateSchedule
    - FixedPrice
    range: Price