Package cdm.event.common

Interface Lineage

All Superinterfaces:
com.rosetta.model.lib.RosettaModelObject
All Known Subinterfaces:
Lineage.LineageBuilder
All Known Implementing Classes:
Lineage.LineageBuilderImpl, Lineage.LineageImpl
@RosettaDataType(value="Lineage", builder=LineageBuilderImpl.class, version="5.30.0") @RuneDataType(value="Lineage", model="cdm", builder=LineageBuilderImpl.class, version="5.30.0") public interface Lineage extends com.rosetta.model.lib.RosettaModelObject
A class to provide lineage information across lifecycle events through a pointer or set of pointers into the event(s), contract(s) and, possibly, payout components that the event is dependent on or relates to. As an example, if an contractFormation event is corrected, the correction event will have a lineage into the initial event, which takes the form of a globalKey into that initial contract formation event. Two referencing mechanisms are provided as part of the CDM: either the globalKey, which corresponds to the hash value of the CDM class which is referred to, or a reference qualifier which is meant to provide support for the ingestion of xml documents with id/href mechanisms. The CDM recommends the use of the globalKey and provides a default implementation which is accessible in the generated code through org.isda.cdm.globalKey.GlobalKeyHashCalculator. If implementers want to use an alternative hashing mechanism, the API in which they need to plug it is com.rosetta.model.lib.HashFunction.
Version:
5.30.0

  • Field Details

  • Method Details

    • getTradeReference

      List<? extends ReferenceWithMetaTrade> getTradeReference()
      Getter Methods

    • getEventReference

      List<? extends ReferenceWithMetaWorkflowStep> getEventReference()
      The reference to the instantiation of an Event object, either through a globalKey or an xml-derived id/href mechanism. The definition associated to the Lineage class provides more details with respect to those referencing approaches, their expected usage and available implementation.

    • getPortfolioStateReference

      List<? extends ReferenceWithMetaPortfolioState> getPortfolioStateReference()
      The reference to the previous state of a Portfolio, in a chain of Events leading up to a build of that Portfolio as the holding of Product(s) in specific Quantity(ies). As part of the PortfolioState object, a pointer to the previous PortfolioState is provided through a Lineage object, together with pointer(s) to the Event or set of Events leading up to the current (new) state.

    • build

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

    • toBuilder

      Lineage.LineageBuilder toBuilder()
      Specified by:
      toBuilder in interface com.rosetta.model.lib.RosettaModelObject

    • builder

      static Lineage.LineageBuilder builder()

    • metaData

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

    • getType

      @RuneAttribute("@type") default Class<? extends Lineage> 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