Package cdm.observable.asset

Enum CashPriceTypeEnum

java.lang.Object

java.lang.Enum<CashPriceTypeEnum>

cdm.observable.asset.CashPriceTypeEnum

All Implemented Interfaces:

Serializable, Comparable<CashPriceTypeEnum>

@RosettaEnum("CashPriceTypeEnum")
public enum CashPriceTypeEnum
extends Enum<CashPriceTypeEnum>

Provides a list of possible types of cash prices, applicable when PriceTypeEnum is itself of type CashPrice.

Version:

5.30.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISCOUNT	Denotes a discount factor expressed as a decimal, e.g. 0.95.
FEE	A generic term for describing a non-scheduled cashflow that can be associated either with the initial contract, with some later corrections to it (e.g. a correction to the day count fraction that has a cashflow impact) or with some lifecycle events.
PREMIUM	Denotes the amount payable by the buyer to the seller for an option.

Method Summary

Modifier and Type	Method	Description
static CashPriceTypeEnum	fromDisplayName(String name)
String	toDisplayString()
String	toString()
static CashPriceTypeEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CashPriceTypeEnum[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PREMIUM

@RosettaEnumValue("Premium")
public static final CashPriceTypeEnum PREMIUM

Denotes the amount payable by the buyer to the seller for an option. The premium is paid on the specified premium payment date or on each premium payment date if specified.

FEE

@RosettaEnumValue("Fee")
public static final CashPriceTypeEnum FEE

A generic term for describing a non-scheduled cashflow that can be associated either with the initial contract, with some later corrections to it (e.g. a correction to the day count fraction that has a cashflow impact) or with some lifecycle events. Fees that are specifically associated with termination and partial termination, increase, amendment, and exercise events are qualified accordingly.

DISCOUNT

@RosettaEnumValue("Discount")
public static final CashPriceTypeEnum DISCOUNT

Denotes a discount factor expressed as a decimal, e.g. 0.95.

Method Details

values

public static CashPriceTypeEnum[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CashPriceTypeEnum valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromDisplayName

public static CashPriceTypeEnum fromDisplayName(String name)

toString

public String toString()

Overrides:

toString in class Enum<CashPriceTypeEnum>

toDisplayString

public String toDisplayString()