.cdm-java.6.0.0-dev.82.source-code.cdm-event-common-BusinessEvent.schema.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdm-java Show documentation
There is a newer version: 6.0.0-dev.89
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "$anchor": "cdm.event.common",
  "type": "object",
  "title": "BusinessEvent",
  "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.",
  "properties": {
    "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.",
      "$ref": "cdm-event-common-EventIntentEnum.schema.json"
    },
    "corporateActionIntent": {
      "$ref": "cdm-event-common-CorporateActionTypeEnum.schema.json"
    },
    "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.",
      "type": "string"
    },
    "effectiveDate": {
      "description": "The date on which the event contractually takes effect, when different from the event date.",
      "type": "string"
    },
    "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.",
      "$ref": "cdm-base-staticdata-identifier-IdentifiedList.schema.json"
    },
    "instruction": {
      "description": "Specifies the instructions to create the Business Event.",
      "type": "array",
      "items": {
        "$ref": "cdm-event-common-Instruction.schema.json"
      },
      "minItems": 0
    },
    "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, ...).",
      "type": "string"
    },
    "after": {
      "description": "Specifies the after trade state(s) created.",
      "type": "array",
      "items": {
        "$ref": "cdm-event-common-TradeState.schema.json"
      },
      "minItems": 0
    }
  }
}