Package cdm.event.workflow

Interface EventInstruction

All Superinterfaces:
com.rosetta.model.lib.RosettaModelObject
All Known Subinterfaces:
BusinessEvent, BusinessEvent.BusinessEventBuilder, EventInstruction.EventInstructionBuilder
All Known Implementing Classes:
BusinessEvent.BusinessEventBuilderImpl, BusinessEvent.BusinessEventImpl, EventInstruction.EventInstructionBuilderImpl, EventInstruction.EventInstructionImpl
@RosettaDataType(value="EventInstruction", builder=EventInstructionBuilderImpl.class, version="5.30.0") @RuneDataType(value="EventInstruction", model="cdm", builder=EventInstructionBuilderImpl.class, version="5.30.0") public interface EventInstruction extends com.rosetta.model.lib.RosettaModelObject
Specifies instructions to create a BusinessEvent.
Version:
5.30.0

  • Field Details

  • Method Details

    • getIntent

      EventIntentEnum getIntent()
      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.

    • getCorporateActionIntent

      CorporateActionTypeEnum getCorporateActionIntent()

    • getEventDate

      com.rosetta.model.lib.records.Date getEventDate()
      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.

    • getEffectiveDate

      com.rosetta.model.lib.records.Date getEffectiveDate()
      The date on which the event contractually takes effect, when different from the event date.

    • getPackageInformation

      IdentifiedList getPackageInformation()
      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.

    • getInstruction

      List<? extends Instruction> getInstruction()
      Specifies the instructions to create the Business Event.

    • build

      EventInstruction build()
      Build Methods
      Specified by:
      build in interface com.rosetta.model.lib.RosettaModelObject

    • toBuilder

      EventInstruction.EventInstructionBuilder toBuilder()
      Specified by:
      toBuilder in interface com.rosetta.model.lib.RosettaModelObject

    • builder

      static EventInstruction.EventInstructionBuilder builder()

    • metaData

      default com.rosetta.model.lib.meta.RosettaMetaData<? extends EventInstruction> metaData()
      Utility Methods
      Specified by:
      metaData in interface com.rosetta.model.lib.RosettaModelObject

    • getType

      @RuneAttribute("@type") default Class<? extends EventInstruction> getType()
      Specified by:
      getType in interface com.rosetta.model.lib.RosettaModelObject

    • process

      default void process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
      Specified by:
      process in interface com.rosetta.model.lib.RosettaModelObject