Class: StockSplitInstruction

name: StockSplitInstruction
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_StockSplit","description":"Function specification to
      create the fully-formed business event which represents the impact of a stock
      split (or a reverse stock split) on an Equity Derivatives contract on a certain
      date.","inputs":[{"name":"stockSplitInstruction","type":"StockSplitInstruction","cardinality":"1..1"},{"name":"before","type":"TradeState","cardinality":"1..1"}],"output":{"name":"after","type":"TradeState","cardinality":"1..1"}}]'
description: Data required to perform a stock split business event.
comments:
- 'Rosetta func: Create_StockSplit — Function specification to create the fully-formed
  business event which represents the impact of a stock split (or a reverse stock
  split) on an Equity Derivatives contract on a certain date.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- adjustmentRatio
- effectiveDate
slot_usage:
  effectiveDate:
    name: effectiveDate
    description: The effective date of the stock split, also known as the ex-date.
      This is the date on which the additional shares are paid to the shareholders,
      or in the case of a reverse stock split, the number shares held by each shareholder
      is proportionally reduced.  Equity derivative transactions can be amended in
      firms' internal systems on such date.   In most markets, the listed stock price
      is reduced (or increased for a reverse stock split) to account for the split
      on the same date, but in some markets the price adjustment occurs on a later
      date.  In either case, equity derivative transactions should be amended on the
      date that the stocks are paid to the shareholders (or consolidated).
    required: true

name: StockSplitInstruction
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_StockSplit","description":"Function specification to
      create the fully-formed business event which represents the impact of a stock
      split (or a reverse stock split) on an Equity Derivatives contract on a certain
      date.","inputs":[{"name":"stockSplitInstruction","type":"StockSplitInstruction","cardinality":"1..1"},{"name":"before","type":"TradeState","cardinality":"1..1"}],"output":{"name":"after","type":"TradeState","cardinality":"1..1"}}]'
description: Data required to perform a stock split business event.
comments:
- 'Rosetta func: Create_StockSplit — Function specification to create the fully-formed
  business event which represents the impact of a stock split (or a reverse stock
  split) on an Equity Derivatives contract on a certain date.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
slot_usage:
  effectiveDate:
    name: effectiveDate
    description: The effective date of the stock split, also known as the ex-date.
      This is the date on which the additional shares are paid to the shareholders,
      or in the case of a reverse stock split, the number shares held by each shareholder
      is proportionally reduced.  Equity derivative transactions can be amended in
      firms' internal systems on such date.   In most markets, the listed stock price
      is reduced (or increased for a reverse stock split) to account for the split
      on the same date, but in some markets the price adjustment occurs on a later
      date.  In either case, equity derivative transactions should be amended on the
      date that the stocks are paid to the shareholders (or consolidated).
    required: true
attributes:
  adjustmentRatio:
    name: adjustmentRatio
    description: The number that denotes the cumulative quantity of post-split shares
      issued to shareholders versus the quantity of pre-split shares previously issued
      to shareholders.  This number will be multiplied by existing shares in an equity
      derivative contract or other positions to determine the post-split number of
      shares.  With regard to any reference to price, the pre-split reference price
      will be divided by this number to determine the post-split reference price.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: StockSplitInstruction
    domain_of:
    - StockSplitInstruction
    range: decimal
    required: true
  effectiveDate:
    name: effectiveDate
    description: The effective date of the stock split, also known as the ex-date.
      This is the date on which the additional shares are paid to the shareholders,
      or in the case of a reverse stock split, the number shares held by each shareholder
      is proportionally reduced.  Equity derivative transactions can be amended in
      firms' internal systems on such date.   In most markets, the listed stock price
      is reduced (or increased for a reverse stock split) to account for the split
      on the same date, but in some markets the price adjustment occurs on a later
      date.  In either case, equity derivative transactions should be amended on the
      date that the stocks are paid to the shareholders (or consolidated).
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CodeValue.effectiveDate
    rank: 1000
    owner: StockSplitInstruction
    domain_of:
    - CodeValue
    - CounterpartyPositionBusinessEvent
    - IndexTransitionInstruction
    - StockSplitInstruction
    - ClosedState
    - EventInstruction
    - LegalAgreementBase
    - MinimumTransferAmountAmendment
    - TerminationCurrencyAmendment
    - PriceQuantity
    - FallbackRateParameters
    - CalculationPeriodDates
    - EconomicTerms
    - CancelableProvision
    range: date
    required: true