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 and Description
TerminationSetting(boolean bIsPerpetual, boolean bIsDefaulted, boolean bHasBeenExercised) Construct the TerminationSetting object from the perpetual flag, defaulted flag, and the has been exercised flag.

Method Summary

Modifier and Type	Method and Description
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 Detail

TerminationSetting

public TerminationSetting(boolean bIsPerpetual,
                          boolean bIsDefaulted,
                          boolean bHasBeenExercised)

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)

Method Detail

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