Skip to content
common-domain-model

Class: QuantityChangeInstruction

Instructions required to create a Quantity Change Primitive Event, which can be either an increase, a decrease or a replacement. An increase adds a new trade lot to the original trade, whereas a decrease subtracts from an existing trade lot’s quantity. A replacement updates the quantity of an existing trade lot to the new value.

URI: common_domain_model:QuantityChangeInstruction

 classDiagram
    class QuantityChangeInstruction
    click QuantityChangeInstruction href "../QuantityChangeInstruction/"
      QuantityChangeInstruction : change
        
          
    
        
        
        QuantityChangeInstruction --> "1..*" PriceQuantity : change
        click PriceQuantity href "../PriceQuantity/"
    

        
      QuantityChangeInstruction : direction
        
          
    
        
        
        QuantityChangeInstruction --> "1" QuantityChangeDirectionEnum : direction
        click QuantityChangeDirectionEnum href "../QuantityChangeDirectionEnum/"
    

        
      QuantityChangeInstruction : lotIdentifier
        
          
    
        
        
        QuantityChangeInstruction --> "*" Identifier : lotIdentifier
        click Identifier href "../Identifier/"

Slots

Section titled “Slots”
Name Cardinality and Range Description Inheritance
change 1..*
PriceQuantity		 Quantity by which the trade is being increased, decreased or replaced, and th… direct
direction 1
QuantityChangeDirectionEnum		 Direction of the quantity change specified as either an increase, decrease or… direct
lotIdentifier *
Identifier		 Identifier for the new lot (in case of increase) or for the existing lot to b… direct

Usages

Section titled “Usages”
used by used in type used
PrimitiveInstruction quantityChange range QuantityChangeInstruction

Identifier and Mapping Information

Section titled “Identifier and Mapping Information”

Schema Source

Section titled “Schema Source”

Mappings

Section titled “Mappings”
Mapping Type Mapped Value
self common_domain_model:QuantityChangeInstruction
native common_domain_model:QuantityChangeInstruction

LinkML Source

Section titled “LinkML Source”

Direct

Section titled “Direct”
name: QuantityChangeInstruction
description: Instructions required to create a Quantity Change Primitive Event, which
  can be either an increase, a decrease or a replacement. An increase adds a new trade
  lot to the original trade, whereas a decrease subtracts from an existing trade lot's
  quantity. A replacement updates the quantity of an existing trade lot to the new
  value.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  change:
    name: change
    description: Quantity by which the trade is being increased, decreased or replaced,
      and the price at which such quantity change is agreed. The quantity change should
      always be specified as a positive number, with the direction (increase/decrease/replacement)
      being specified by the direction enumeration. A fee can also be associated to
      the quantity change by specifying a Price component of type CashPrice, including
      the corresponding settlement date and direction.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - QuantityChangeInstruction
    range: PriceQuantity
    required: true
    multivalued: true
  direction:
    name: direction
    description: Direction of the quantity change specified as either an increase,
      decrease or replacement.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - QuantityChangeInstruction
    - DirectionRating
    range: QuantityChangeDirectionEnum
    required: true
  lotIdentifier:
    name: lotIdentifier
    description: Identifier for the new lot (in case of increase) or for the existing
      lot to be changed(in case of decrease or replacement). This optional attribute
      is mandatory in case of a decrease or replacement if the initial trade state
      contains multiple trade lots.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    domain_of:
    - ExecutionInstruction
    - QuantityChangeInstruction
    - TradeLot
    range: Identifier
    multivalued: true

Induced

Section titled “Induced”
name: QuantityChangeInstruction
description: Instructions required to create a Quantity Change Primitive Event, which
  can be either an increase, a decrease or a replacement. An increase adds a new trade
  lot to the original trade, whereas a decrease subtracts from an existing trade lot's
  quantity. A replacement updates the quantity of an existing trade lot to the new
  value.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  change:
    name: change
    description: Quantity by which the trade is being increased, decreased or replaced,
      and the price at which such quantity change is agreed. The quantity change should
      always be specified as a positive number, with the direction (increase/decrease/replacement)
      being specified by the direction enumeration. A fee can also be associated to
      the quantity change by specifying a Price component of type CashPrice, including
      the corresponding settlement date and direction.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: QuantityChangeInstruction
    domain_of:
    - QuantityChangeInstruction
    range: PriceQuantity
    required: true
    multivalued: true
  direction:
    name: direction
    description: Direction of the quantity change specified as either an increase,
      decrease or replacement.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: QuantityChangeInstruction
    domain_of:
    - QuantityChangeInstruction
    - DirectionRating
    range: QuantityChangeDirectionEnum
    required: true
  lotIdentifier:
    name: lotIdentifier
    description: Identifier for the new lot (in case of increase) or for the existing
      lot to be changed(in case of decrease or replacement). This optional attribute
      is mandatory in case of a decrease or replacement if the initial trade state
      contains multiple trade lots.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    owner: QuantityChangeInstruction
    domain_of:
    - ExecutionInstruction
    - QuantityChangeInstruction
    - TradeLot
    range: Identifier
    multivalued: true