Package org.isda.cdm
Class Event
- java.lang.Object
-
- com.rosetta.model.lib.RosettaModelObject
-
- org.isda.cdm.Event
-
- All Implemented Interfaces:
com.rosetta.model.lib.GlobalKey
@RosettaClass @RosettaQualified(attribute="eventQualifier", qualifiedClass=Event.class) public class Event extends com.rosetta.model.lib.RosettaModelObject implements com.rosetta.model.lib.GlobalKey
A class to specify the lifecycle event. The associated rosettaKey denotes the ability to associate a hash value to the Event instantiation for the purpose of model cross-referencing, in support of functionality such as the event effect and the lineage.- Version:
- 2.5.4
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Event.EventBuilder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Event.EventBuilder
builder()
boolean
equals(java.lang.Object o)
java.util.List<Account>
getAccount()
Optional account information that could be associated to the event.ActionEnum
getAction()
Specifies whether the event is a new, a correction or a cancellation.com.rosetta.model.lib.records.Date
getEffectiveDate()
The date on which the event contractually takes effect, when different from the event date.com.rosetta.model.lib.records.Date
getEventDate()
The date on which the event is taking place.EventEffect
getEventEffect()
The set of effects associated with the lifecycle event, i.e.java.util.List<Identifier>
getEventIdentifier()
The identifier(s) that uniquely identify a lifecycle event.java.lang.String
getEventQualifier()
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.EventWorkflow
getEventWorkflow()
The event workflow information, i.e.java.lang.String
getFunctionCall()
This is placeholder concept for a function call into a calculation that will return an outcome.IntentEnum
getIntent()
The intent attribute is meant to be specified when the event qualification cannot be programmatically inferred from the event features.Lineage
getLineage()
The lineage attribute provides a linkage among lifecycle events through the rosettaKey hash value.MessageInformation
getMessageInformation()
MetaFields
getMeta()
java.util.List<Party>
getParty()
The specification of the event parties.PrimitiveEvent
getPrimitive()
The elemental component(s) that specify the lifecycle events.java.util.List<EventTimestamp>
getTimestamp()
The set of timestamp(s) associated with the event as a collection of [dateTime, qualifier].int
hashCode()
com.rosetta.model.lib.meta.RosettaMetaData<? extends Event>
metaData()
void
process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
Event.EventBuilder
toBuilder()
java.lang.String
toString()
-
-
-
Method Detail
-
getAccount
@RosettaSynonym(value="account",source="FpML_5_10") @RosettaSynonym(value="account",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="account",source="DTCC_11_0") @RosettaSynonym(value="account",source="DTCC_9_0") @RosettaSynonym(value="account",source="CME_ClearedConfirm_1_17",path="clearingConfirmed") public final java.util.List<Account> getAccount()
Optional account information that could be associated to the event.
-
getAction
@RosettaSynonym(value="",source="Rosetta_Workbench") @RosettaSynonym(value="",source="FpML_5_10") @RosettaSynonym(value="Activity",source="DTCC_11_0",path="Header.OTC_RM.Manifest.TradeMsg") @RosettaSynonym(value="Activity",source="DTCC_9_0",path="Header.OTC_RM.Manifest.TradeMsg") @RosettaSynonym(value="TransTyp",source="CME_SubmissionIRS_1_0",path="TrdCaptRpt") public final ActionEnum getAction()
Specifies whether the event is a new, a correction or a cancellation.
-
getEffectiveDate
@RosettaSynonym(value="effectiveDate", source="Rosetta_Workbench") public final com.rosetta.model.lib.records.Date getEffectiveDate()
The date on which the event contractually takes effect, when different from the event date.
-
getEventDate
@RosettaSynonym(value="eventDate",source="Rosetta_Workbench") @RosettaSynonym(value="clearedDate",source="CME_ClearedConfirm_1_17",path="clearingConfirmed.trade.tradeHeader",maps=2) public final com.rosetta.model.lib.records.Date getEventDate()
The date on which the event is taking place. This is the equivalent of the trade date in the case of an execution or a contract.
-
getEventEffect
public final EventEffect getEventEffect()
The set of effects associated with the lifecycle event, i.e. generated cashflows, contracts (from, say, novation events), listed products (from, say, a bond option exercise event) values and more. Those are represented through a set of rosettaKey references. This attribute is optional in order to provide implementers with the ability not to make use of this feature.
-
getEventIdentifier
@RosettaSynonym(value="eventIdentifier",source="Rosetta_Workbench") @RosettaSynonym(value="Submitter",source="DTCC_11_0",path="Header.OTC_RM.Manifest.TradeMsg") @RosettaSynonym(value="Submitter",source="DTCC_9_0",path="Header.OTC_RM.Manifest.TradeMsg") @RosettaSynonym(value="ContraTradeId",source="DTCC_11_0",path="Header.OTC_RM.Manifest.TradeMsg") @RosettaSynonym(value="ContraTradeId",source="DTCC_9_0",path="Header.OTC_RM.Manifest.TradeMsg") @RosettaSynonym(value="YourTradeId",source="DTCC_11_0",path="Header.OTC_RM.Manifest.TradeMsg") @RosettaSynonym(value="YourTradeId",source="DTCC_9_0",path="Header.OTC_RM.Manifest.TradeMsg") @RosettaSynonym(value="tradeIdentifyingItems",source="DTCC_11_0",path="Header.OTC_RM.Manifest.TradeMsg") @RosettaSynonym(value="tradeIdentifyingItems",source="DTCC_9_0",path="Header.OTC_RM.Manifest.TradeMsg") public final java.util.List<Identifier> getEventIdentifier()
The identifier(s) that uniquely identify a lifecycle event. The unbounded cardinality is meant to provide the ability to associate identifiers that are issued by distinct parties. As an example, each of the parties to the event may choose to associate their own identifiers to the event.
-
getEventQualifier
public final java.lang.String getEventQualifier()
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, ...).
-
getEventWorkflow
public final EventWorkflow getEventWorkflow()
The event workflow information, i.e. the workflow status, the associated comment and the partyCustomisedWorkflow which purpose is to provide the ability to associate custom workflow information to the CDM.
-
getFunctionCall
@RosettaSynonym(value="functionCall", source="Rosetta_Workbench") public final java.lang.String getFunctionCall()
This is placeholder concept for a function call into a calculation that will return an outcome. This concept needs to be further firmed out.
-
getIntent
@RosettaSynonym(value="intent", source="Rosetta_Workbench") public final IntentEnum 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.
-
getLineage
@RosettaSynonym(value="lineage", source="Rosetta_Workbench") public final Lineage getLineage()
The lineage attribute provides a linkage among lifecycle events through the rosettaKey hash value. One example is when a given lifecycle event is being corrected or cancelled. In such case, each subsequent event will have lineage into the prior version of that event. The second broad use case is when an event has a dependency upon either another event (e.g. the regular payment associated with a fix/float swap will have a lineage into the reset event, which will in turn have a lineage into the observation event for the floating rate and the contract) or a contract (e.g. the exercise of an option has a lineage into that option).
-
getMessageInformation
@RosettaSynonym(value="FpML",source="DTCC_11_0",path="Body.OTC_Matching.Trade") @RosettaSynonym(value="FpML",source="DTCC_9_0",path="Body.OTC_Matching.Trade") @RosettaSynonym(value="FpML",source="DTCC_11_0",path="Body.OTC_Matching.Payment") @RosettaSynonym(value="FpML",source="DTCC_9_0",path="Body.OTC_Matching.Payment") @RosettaSynonym(value="RouteInfo",source="DTCC_11_0",path="Header.OTC_RM.Delivery") @RosettaSynonym(value="RouteInfo",source="DTCC_9_0",path="Header.OTC_RM.Delivery") @RosettaSynonym(value="Manifest",source="DTCC_11_0",path="Header.OTC_RM") @RosettaSynonym(value="Manifest",source="DTCC_9_0",path="Header.OTC_RM") @RosettaSynonym(value="header",source="CME_ClearedConfirm_1_17",path="clearingConfirmed") public final MessageInformation getMessageInformation()
-
getMeta
public final MetaFields getMeta()
- Specified by:
getMeta
in interfacecom.rosetta.model.lib.GlobalKey
-
getParty
@RosettaSynonym(value="party",source="FpML_5_10") @RosettaSynonym(value="party",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="party",source="CME_ClearedConfirm_1_17") @RosettaSynonym(value="party",source="DTCC_11_0",path="Body.OTC_Matching.Trade.FpML") @RosettaSynonym(value="party",source="DTCC_9_0",path="Body.OTC_Matching.Trade.FpML") @RosettaSynonym(value="party",source="DTCC_11_0",path="Body.OTC_Matching.Payment.FpML") @RosettaSynonym(value="party",source="DTCC_9_0",path="Body.OTC_Matching.Payment.FpML") public final java.util.List<Party> getParty()
The specification of the event parties. This attribute is optional, as not applicable to certain events (e.g. most of the observations).
-
getPrimitive
@RosettaSynonym(value="primitive", source="Rosetta_Workbench") public final PrimitiveEvent getPrimitive()
The elemental component(s) that specify the lifecycle events. Each of the primitive/elemental components listed as part of the PrimitiveEvent class has distinctive features that allow to specify the lifecycle event, either by itself or in combination with some other of such components.
-
getTimestamp
@RosettaSynonym(value="timestamp",source="Rosetta_Workbench") @RosettaSynonym(value="header",source="DTCC_11_0",path="Body.OTC_Matching.Trade.FpML") @RosettaSynonym(value="header",source="DTCC_9_0",path="Body.OTC_Matching.Trade.FpML") @RosettaSynonym(value="Route",source="DTCC_11_0",path="Header.OTC_RM.Delivery.RouteHist") @RosettaSynonym(value="Route",source="DTCC_9_0",path="Header.OTC_RM.Delivery.RouteHist") @RosettaSynonym(value="header",source="DTCC_11_0",path="Body.OTC_Matching.Payment.FpML") @RosettaSynonym(value="header",source="DTCC_9_0",path="Body.OTC_Matching.Payment.FpML") @RosettaSynonym(value="timestamps",source="CME_ClearedConfirm_1_17",path="clearingConfirmed.trade.tradeHeader") @RosettaSynonym(value="header",source="CME_ClearedConfirm_1_17",path="clearingConfirmed") public final java.util.List<EventTimestamp> getTimestamp()
The set of timestamp(s) associated with the event as a collection of [dateTime, qualifier].
-
metaData
public com.rosetta.model.lib.meta.RosettaMetaData<? extends Event> metaData()
- Specified by:
metaData
in classcom.rosetta.model.lib.RosettaModelObject
-
toBuilder
public Event.EventBuilder toBuilder()
- Specified by:
toBuilder
in classcom.rosetta.model.lib.RosettaModelObject
-
builder
public static Event.EventBuilder builder()
-
process
public void process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
- Specified by:
process
in classcom.rosetta.model.lib.RosettaModelObject
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-