Interface ClosedState

All Superinterfaces:
com.rosetta.model.lib.RosettaModelObject
All Known Subinterfaces:
ClosedState.ClosedStateBuilder
All Known Implementing Classes:
ClosedState.ClosedStateBuilderImpl, ClosedState.ClosedStateImpl

@RosettaDataType(value="ClosedState", builder=ClosedStateBuilderImpl.class, version="5.30.0") @RuneDataType(value="ClosedState", model="cdm", builder=ClosedStateBuilderImpl.class, version="5.30.0") public interface ClosedState extends com.rosetta.model.lib.RosettaModelObject
A class to qualify the closed state of an execution or a contract through the combination or a state (e.g. terminated, novated) and a set of dates: activity date, effective date and, when relevant, last payment date.
Version:
5.30.0
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Builder Interface
    static class 
    Builder Implementation of ClosedState
    static class 
    Immutable Implementation of ClosedState
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final ClosedStateMeta
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Build Methods
     
    com.rosetta.model.lib.records.Date
    The activity date on which the closing state took place, i.e. either the event date of the closing event (e.g. option exercise, contract early termination) or the contractual termination date.
    com.rosetta.model.lib.records.Date
    The date on which the closing event contractually takes effect, when different from the activity date.
    com.rosetta.model.lib.records.Date
    The date associated with the last payment in relation to the artefact (e.g. contract) to which this closed state applies.
    The qualification of what gave way to the contract or execution closure, e.g. allocation, termination, ...
    default Class<? extends ClosedState>
     
    default com.rosetta.model.lib.meta.RosettaMetaData<? extends ClosedState>
    Utility Methods
    default void
    process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
     
     

    Methods inherited from interface com.rosetta.model.lib.RosettaModelObject

    processRosetta, processRosetta
  • Field Details

  • Method Details

    • getState

      ClosedStateEnum getState()
      The qualification of what gave way to the contract or execution closure, e.g. allocation, termination, ...
    • getActivityDate

      com.rosetta.model.lib.records.Date getActivityDate()
      The activity date on which the closing state took place, i.e. either the event date of the closing event (e.g. option exercise, contract early termination) or the contractual termination date.
    • getEffectiveDate

      com.rosetta.model.lib.records.Date getEffectiveDate()
      The date on which the closing event contractually takes effect, when different from the activity date. When an explicit event effective date attribute is associated with the closing event, it will be that date. In the case of a cancellation event, it will be the date on which the cancelled event took place.
    • getLastPaymentDate

      com.rosetta.model.lib.records.Date getLastPaymentDate()
      The date associated with the last payment in relation to the artefact (e.g. contract) to which this closed state applies. As an example, in the case of an early termination event, it would be the settlement date of the associated fee, if applicable.
    • build

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

      Specified by:
      toBuilder in interface com.rosetta.model.lib.RosettaModelObject
    • builder

    • metaData

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

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