Class: Instruction

Instruction to a function that will be used to perform a business event

 classDiagram
    class Instruction
    click Instruction href "../Instruction/"
      Instruction : before





        Instruction --> "0..1" TradeState : before
        click TradeState href "../TradeState/"



      Instruction : primitiveInstruction





        Instruction --> "0..1" PrimitiveInstruction : primitiveInstruction
        click PrimitiveInstruction href "../PrimitiveInstruction/"

Class Properties

Property	Value
Tree Root	Yes

Slots

Name	Cardinality and Range	Description	Inheritance
primitiveInstruction	0..1 PrimitiveInstruction	Specifies the primitive instructions that will be used to call primitive even...	direct
before	0..1 TradeState	Specifies the trade state that will be acted on by the primitive event functi...	direct

Usages

used by	used in	type	used
BusinessEvent	instruction	range	Instruction
EventInstruction	instruction	range	Instruction

In Subsets

CdmEventCommon

Comments

Rosetta condition: ExclusiveSplitPrimitive — if primitiveInstruction -> split exists then primitiveInstruction -> split only exists
Rosetta condition: NewTrade — (if primitiveInstruction -> execution exists then before is absent else True) and (if before is absent then primitiveInstruction -> execution exists else True)
Rosetta func: Create_PairOffInstruction — Creates a set of instructions to pair-off a set of trades based on a pair reference. A package component is created based on that pair reference and the list of identifiers for the underlying trades. That package component is then added onto the execution details of every underlying trade. The existing trades are not terminated.
Rosetta func: Create_BusinessEvent — Creates a business event from instructions containing primitive instructions and optionally a trade state.

Identifier and Mapping Information

Annotations

property

value

rosetta_functions

[{"name":"Create_PairOffInstruction","description":"Creates a set of instructions to pair-off a set of trades based on a pair reference. A package component is created based on that pair reference and the list of identifiers for the underlying trades. That package component is then added onto the execution details of every underlying trade. The existing trades are not terminated.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"2.."},{"name":"pairReference","type":"Identifier","cardinality":"1..1"}],"output":{"name":"instruction","type":"Instruction","cardinality":"1.."}},{"name":"Create_BusinessEvent","description":"Creates a business event from instructions containing primitive instructions and optionally a trade state.","inputs":[{"name":"instruction","type":"Instruction","cardinality":"1..*"},{"name":"intent","type":"EventIntentEnum","cardinality":"0..1"},{"name":"eventDate","type":"date","cardinality":"1..1"},{"name":"effectiveDate","type":"date","cardinality":"1..1"}],"output":{"name":"businessEvent","type":"BusinessEvent","cardinality":"1..1"}}]

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Instruction
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_PairOffInstruction","description":"Creates a set of instructions
      to pair-off a set of trades based on a pair reference. A package component is
      created based on that pair reference and the list of identifiers for the underlying
      trades. That package component is then added onto the execution details of every
      underlying trade. The existing trades are not terminated.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"2..*"},{"name":"pairReference","type":"Identifier","cardinality":"1..1"}],"output":{"name":"instruction","type":"Instruction","cardinality":"1..*"}},{"name":"Create_BusinessEvent","description":"Creates
      a business event from instructions containing primitive instructions and optionally
      a trade state.","inputs":[{"name":"instruction","type":"Instruction","cardinality":"1..*"},{"name":"intent","type":"EventIntentEnum","cardinality":"0..1"},{"name":"eventDate","type":"date","cardinality":"1..1"},{"name":"effectiveDate","type":"date","cardinality":"1..1"}],"output":{"name":"businessEvent","type":"BusinessEvent","cardinality":"1..1"}}]'
description: Instruction to a function that will be used to perform a business event
comments:
- 'Rosetta condition: ExclusiveSplitPrimitive — if primitiveInstruction -> split exists
  then primitiveInstruction -> split only exists'
- 'Rosetta condition: NewTrade — (if primitiveInstruction -> execution exists then
  before is absent else True) and (if before is absent then primitiveInstruction ->
  execution exists else True)'
- 'Rosetta func: Create_PairOffInstruction — Creates a set of instructions to pair-off
  a set of trades based on a pair reference. A package component is created based
  on that pair reference and the list of identifiers for the underlying trades. That
  package component is then added onto the execution details of every underlying trade.
  The existing trades are not terminated.'
- 'Rosetta func: Create_BusinessEvent — Creates a business event from instructions
  containing primitive instructions and optionally a trade state.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- primitiveInstruction
- before
tree_root: true

Induced

name: Instruction
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_PairOffInstruction","description":"Creates a set of instructions
      to pair-off a set of trades based on a pair reference. A package component is
      created based on that pair reference and the list of identifiers for the underlying
      trades. That package component is then added onto the execution details of every
      underlying trade. The existing trades are not terminated.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"2..*"},{"name":"pairReference","type":"Identifier","cardinality":"1..1"}],"output":{"name":"instruction","type":"Instruction","cardinality":"1..*"}},{"name":"Create_BusinessEvent","description":"Creates
      a business event from instructions containing primitive instructions and optionally
      a trade state.","inputs":[{"name":"instruction","type":"Instruction","cardinality":"1..*"},{"name":"intent","type":"EventIntentEnum","cardinality":"0..1"},{"name":"eventDate","type":"date","cardinality":"1..1"},{"name":"effectiveDate","type":"date","cardinality":"1..1"}],"output":{"name":"businessEvent","type":"BusinessEvent","cardinality":"1..1"}}]'
description: Instruction to a function that will be used to perform a business event
comments:
- 'Rosetta condition: ExclusiveSplitPrimitive — if primitiveInstruction -> split exists
  then primitiveInstruction -> split only exists'
- 'Rosetta condition: NewTrade — (if primitiveInstruction -> execution exists then
  before is absent else True) and (if before is absent then primitiveInstruction ->
  execution exists else True)'
- 'Rosetta func: Create_PairOffInstruction — Creates a set of instructions to pair-off
  a set of trades based on a pair reference. A package component is created based
  on that pair reference and the list of identifiers for the underlying trades. That
  package component is then added onto the execution details of every underlying trade.
  The existing trades are not terminated.'
- 'Rosetta func: Create_BusinessEvent — Creates a business event from instructions
  containing primitive instructions and optionally a trade state.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  primitiveInstruction:
    name: primitiveInstruction
    description: Specifies the primitive instructions that will be used to call primitive
      event functions.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: Instruction
    domain_of:
    - Instruction
    range: PrimitiveInstruction
  before:
    name: before
    annotations:
      metadata_reference:
        tag: metadata_reference
        value: true
    description: Specifies the trade state that will be acted on by the primitive
      event functions.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: Instruction
    domain_of:
    - Instruction
    range: TradeState
tree_root: true