Package org.drip.product.params

Class TerminationSetting

java.lang.Object
org.drip.product.params.TerminationSetting
All Implemented Interfaces:
Validatable
public class TerminationSetting
extends java.lang.Object
implements Validatable
TerminationSetting class contains the current "liveness" state of the component, and, if inactive, how it entered that state. It exports serialization into and de-serialization out of byte arrays.



Author:
Lakshmi Krishnamurthy

  • Constructor Summary

    Constructors
    Constructor Description
    TerminationSetting​(boolean bIsPerpetual, boolean bIsDefaulted, boolean bHasBeenExercised, DateAdjustParams dap)
    Construct the TerminationSetting object from the perpetual flag, defaulted flag, and the has been exercised flag.

  • Method Summary

    Modifier and Type Method Description
    DateAdjustParams dap()
    Retrieve the Termination Setting Date Adjustment Parameters
    boolean defaulted()
    Indicate if the contract has defaulted
    boolean exercised()
    Indicate if the contract has been exercised
    boolean perpetual()
    Indicate if the contract is perpetual
    boolean validate()
    Validate the current object state

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • TerminationSetting

      public TerminationSetting​(boolean bIsPerpetual, boolean bIsDefaulted, boolean bHasBeenExercised, DateAdjustParams dap)
      Construct the TerminationSetting object from the perpetual flag, defaulted flag, and the has been exercised flag.
      Parameters:
      bIsPerpetual - True (component is perpetual)
      bIsDefaulted - True (component has defaulted)
      bHasBeenExercised - True (component has been exercised)
      dap - The Termination Date Adjustment Parameters

  • Method Details

    • validate

      public boolean validate()
      Description copied from interface: Validatable
      Validate the current object state
      Specified by:
      validate in interface Validatable
      Returns:
      Validation successful (true) or failed (false)

    • defaulted

      public boolean defaulted()
      Indicate if the contract has defaulted
      Returns:
      TRUE - The Contract has defaulted

    • perpetual

      public boolean perpetual()
      Indicate if the contract is perpetual
      Returns:
      TRUE - The Contract is Perpetual

    • exercised

      public boolean exercised()
      Indicate if the contract has been exercised
      Returns:
      TRUE - The Contract has been exercised

    • dap

      public DateAdjustParams dap()
      Retrieve the Termination Setting Date Adjustment Parameters
      Returns:
      The Termination Setting Date Adjustment Parameters