Class: BusinessEvent

name: BusinessEvent
annotations:
  metadata_key:
    tag: metadata_key
    value: true
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_Return","description":"Defines the process of partially
      or fully returning a Security Lending Transaction.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"1..1"},{"name":"returnInstruction","type":"ReturnInstruction","cardinality":"1..1"},{"name":"returnDate","type":"date","cardinality":"1..1"}],"output":{"name":"returnEvent","type":"BusinessEvent","cardinality":"1..1"}},{"name":"Qualify_Substitution","description":"Qualification
      of a collateral substitution event.","inputs":[{"name":"businessEvent","type":"BusinessEvent","cardinality":"1..1"}],"output":{"name":"is_event","type":"boolean","cardinality":"1..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"}},{"name":"ExtractBeforeEconomicTerms","inputs":[{"name":"businessEvent","type":"BusinessEvent","cardinality":"1..1"}],"output":{"name":"economicTerms","type":"EconomicTerms","cardinality":"0..1"}},{"name":"ExtractOpenEconomicTerms","inputs":[{"name":"businessEvent","type":"BusinessEvent","cardinality":"1..1"}],"output":{"name":"economicTerms","type":"EconomicTerms","cardinality":"0..1"}},{"name":"ExtractBeforeTrade","inputs":[{"name":"businessEvent","type":"BusinessEvent","cardinality":"1..1"}],"output":{"name":"trade","type":"Trade","cardinality":"0..1"}},{"name":"ExtractAfterTrade","inputs":[{"name":"businessEvent","type":"BusinessEvent","cardinality":"1..1"}],"output":{"name":"trade","type":"Trade","cardinality":"0..1"}}]'
description: A business event represents a life cycle event of a trade. The combination
  of the state changes results in a qualifiable life cycle event. An example of a
  Business Event is a PartialTermination which is a defined by a quantity change primitive
  event.
comments:
- 'Rosetta condition: EventDate — eventDate exists'
- 'Rosetta func: Create_Return — Defines the process of partially or fully returning
  a Security Lending Transaction.'
- 'Rosetta func: Qualify_Substitution — Qualification of a collateral substitution
  event.'
- 'Rosetta func: Create_BusinessEvent — Creates a business event from instructions
  containing primitive instructions and optionally a trade state.'
- 'Rosetta func: ExtractBeforeEconomicTerms'
- 'Rosetta func: ExtractOpenEconomicTerms'
- 'Rosetta func: ExtractBeforeTrade'
- 'Rosetta func: ExtractAfterTrade'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:BusinessEvent
- gist:Event
is_a: EventInstruction
slots:
- eventQualifier
- after
tree_root: true
rules:
- postconditions:
    slot_conditions:
      eventDate:
        name: eventDate
        required: true
  description: EventDate

name: BusinessEvent
annotations:
  metadata_key:
    tag: metadata_key
    value: true
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_Return","description":"Defines the process of partially
      or fully returning a Security Lending Transaction.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"1..1"},{"name":"returnInstruction","type":"ReturnInstruction","cardinality":"1..1"},{"name":"returnDate","type":"date","cardinality":"1..1"}],"output":{"name":"returnEvent","type":"BusinessEvent","cardinality":"1..1"}},{"name":"Qualify_Substitution","description":"Qualification
      of a collateral substitution event.","inputs":[{"name":"businessEvent","type":"BusinessEvent","cardinality":"1..1"}],"output":{"name":"is_event","type":"boolean","cardinality":"1..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"}},{"name":"ExtractBeforeEconomicTerms","inputs":[{"name":"businessEvent","type":"BusinessEvent","cardinality":"1..1"}],"output":{"name":"economicTerms","type":"EconomicTerms","cardinality":"0..1"}},{"name":"ExtractOpenEconomicTerms","inputs":[{"name":"businessEvent","type":"BusinessEvent","cardinality":"1..1"}],"output":{"name":"economicTerms","type":"EconomicTerms","cardinality":"0..1"}},{"name":"ExtractBeforeTrade","inputs":[{"name":"businessEvent","type":"BusinessEvent","cardinality":"1..1"}],"output":{"name":"trade","type":"Trade","cardinality":"0..1"}},{"name":"ExtractAfterTrade","inputs":[{"name":"businessEvent","type":"BusinessEvent","cardinality":"1..1"}],"output":{"name":"trade","type":"Trade","cardinality":"0..1"}}]'
description: A business event represents a life cycle event of a trade. The combination
  of the state changes results in a qualifiable life cycle event. An example of a
  Business Event is a PartialTermination which is a defined by a quantity change primitive
  event.
comments:
- 'Rosetta condition: EventDate — eventDate exists'
- 'Rosetta func: Create_Return — Defines the process of partially or fully returning
  a Security Lending Transaction.'
- 'Rosetta func: Qualify_Substitution — Qualification of a collateral substitution
  event.'
- 'Rosetta func: Create_BusinessEvent — Creates a business event from instructions
  containing primitive instructions and optionally a trade state.'
- 'Rosetta func: ExtractBeforeEconomicTerms'
- 'Rosetta func: ExtractOpenEconomicTerms'
- 'Rosetta func: ExtractBeforeTrade'
- 'Rosetta func: ExtractAfterTrade'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:BusinessEvent
- gist:Event
is_a: EventInstruction
attributes:
  eventQualifier:
    name: eventQualifier
    description: The CDM event qualifier, which corresponds to the outcome of the
      isEvent qualification logic which qualifies the lifecycle event as a function
      of its features (e.g. PartialTermination, ClearingSubmission, Novation, ...).
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:BusinessEvent.eventQualifier
    rank: 1000
    owner: BusinessEvent
    domain_of:
    - BusinessEvent
    range: string
  after:
    name: after
    description: Specifies the after trade state(s) created.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:BusinessEvent.after
    rank: 1000
    owner: BusinessEvent
    domain_of:
    - BusinessEvent
    - CounterpartyPositionBusinessEvent
    range: TradeState
    multivalued: true
    inlined: true
    inlined_as_list: true
  intent:
    name: intent
    description: The intent attribute is meant to be specified when the event qualification
      cannot be programmatically inferred from the event features. As a result it
      is only associated with those primitives that can give way to such ambiguity,
      the quantityChange being one of those. An example of such is a reduction in
      the trade notional, which could be interpreted as either a trade correction
      (unless a maximum period of time post-event is specified as part of the qualification),
      a partial termination or a portfolio rebalancing in the case of an equity swap.
      On the other hand, an event such as the exercise is not expected to have an
      associated intent as there should not be ambiguity.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: BusinessEvent
    domain_of:
    - CounterpartyPositionBusinessEvent
    - EventInstruction
    range: EventIntentEnum
    required: false
  corporateActionIntent:
    name: corporateActionIntent
    description: The intent of a corporate action on the position.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: BusinessEvent
    domain_of:
    - CounterpartyPositionBusinessEvent
    - EventInstruction
    range: CorporateActionTypeEnum
  eventDate:
    name: eventDate
    description: Specifies the date on which the event is taking place. This date
      is equal to the trade date in the case of a simple execution.  However it can
      be different from the trade date, for example in the case of a partial termination.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: BusinessEvent
    domain_of:
    - CounterpartyPositionBusinessEvent
    - EventInstruction
    range: date
  eventTime:
    name: eventTime
    description: The time and zone of the date in which the event is taking place.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: BusinessEvent
    domain_of:
    - EventInstruction
    range: TimeZone
  effectiveDate:
    name: effectiveDate
    description: The date on which the event contractually takes effect, when different
      from the event date.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CodeValue.effectiveDate
    rank: 1000
    owner: BusinessEvent
    domain_of:
    - CodeValue
    - CounterpartyPositionBusinessEvent
    - IndexTransitionInstruction
    - StockSplitInstruction
    - ClosedState
    - EventInstruction
    - LegalAgreementBase
    - MinimumTransferAmountAmendment
    - TerminationCurrencyAmendment
    - PriceQuantity
    - FallbackRateParameters
    - CalculationPeriodDates
    - EconomicTerms
    - CancelableProvision
    range: date
  effectiveTime:
    name: effectiveTime
    description: The time and zone of the date in which the event contractually takes
      effect.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: BusinessEvent
    domain_of:
    - EventInstruction
    - EconomicTerms
    range: TimeZone
  packageInformation:
    name: packageInformation
    description: Specifies the package information in case the business event represents
      several trades executed as a package (hence this attribute is optional). The
      package information is only instantiated once at the business event level to
      preserve referential integrity, whereas individual trades make reference to
      it to identify that they are part of a package.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: BusinessEvent
    domain_of:
    - CounterpartyPositionBusinessEvent
    - EventInstruction
    range: IdentifiedList
  instruction:
    name: instruction
    description: Specifies the instructions to create the Business Event.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: BusinessEvent
    domain_of:
    - EventInstruction
    range: Instruction
    multivalued: true
    inlined: true
    inlined_as_list: true
tree_root: true
rules:
- postconditions:
    slot_conditions:
      eventDate:
        name: eventDate
        required: true
  description: EventDate