Lusid.Sdk.Model.CashElection Class Reference

Cash election for Events that result in a cash payment. More...

Inheritance diagram for Lusid.Sdk.Model.CashElection:

Public Member Functions
	CashElection (string electionKey=default(string), decimal? exchangeRate=default(decimal?), decimal? dividendRate=default(decimal?), bool isChosen=default(bool), bool isDeclared=default(bool), bool isDefault=default(bool), string dividendCurrency=default(string))
	Initializes a new instance of the CashElection class. More...
override string	ToString ()
	Returns the string presentation of the object More...
virtual string	ToJson ()
	Returns the JSON string presentation of the object More...
override bool	Equals (object input)
	Returns true if objects are equal More...
bool	Equals (CashElection input)
	Returns true if CashElection instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	CashElection ()
	Initializes a new instance of the CashElection class. More...

Properties
string	ElectionKey [get, set]
	Unique key used to identify this election. More...
decimal?	ExchangeRate [get, set]
	The exchange rate if this is not the declared CashElection. Defaults to 1 if Election is Declared. More...
decimal?	DividendRate [get, set]
	The payment rate for this CashElection. More...
bool	IsChosen [get, set]
	Has this election been chosen. Only one Election may be Chosen per Event. More...
bool	IsDeclared [get, set]
	Is this the declared CashElection. Only one Election may be Declared per Event. More...
bool	IsDefault [get, set]
	Is this election the default. Only one Election may be Default per Event More...
string	DividendCurrency [get, set]
	The payment currency for this CashElection. More...

Detailed Description

Cash election for Events that result in a cash payment.

Constructor & Destructor Documentation

CashElection() [1/2]

Lusid.Sdk.Model.CashElection.CashElection ( )

inlineprotected

Initializes a new instance of the CashElection class.

CashElection() [2/2]

Lusid.Sdk.Model.CashElection.CashElection ( string  electionKey = default(string), decimal?  exchangeRate = default(decimal?), decimal?  dividendRate = default(decimal?), bool  isChosen = default(bool), bool  isDeclared = default(bool), bool  isDefault = default(bool), string  dividendCurrency = default(string)  )

inline

Initializes a new instance of the CashElection class.

Parameters

electionKey	Unique key used to identify this election. (required).
exchangeRate	The exchange rate if this is not the declared CashElection. Defaults to 1 if Election is Declared..
dividendRate	The payment rate for this CashElection..
isChosen	Has this election been chosen. Only one Election may be Chosen per Event..
isDeclared	Is this the declared CashElection. Only one Election may be Declared per Event..
isDefault	Is this election the default. Only one Election may be Default per Event.
dividendCurrency	The payment currency for this CashElection. (required).

Member Function Documentation

Equals() [1/2]

bool Lusid.Sdk.Model.CashElection.Equals ( CashElection  input )

inline

Returns true if CashElection instances are equal

Parameters

input

Instance of CashElection to be compared

Returns

Boolean

Equals() [2/2]

override bool Lusid.Sdk.Model.CashElection.Equals ( object  input )

inline

Returns true if objects are equal

Parameters

input

Object to be compared

Returns

Boolean

GetHashCode()

override int Lusid.Sdk.Model.CashElection.GetHashCode ( )

inline

Gets the hash code

Returns

Hash code

ToJson()

virtual string Lusid.Sdk.Model.CashElection.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

override string Lusid.Sdk.Model.CashElection.ToString ( )

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

DividendCurrency

string Lusid.Sdk.Model.CashElection.DividendCurrency

getset

The payment currency for this CashElection.

The payment currency for this CashElection.

DividendRate

decimal? Lusid.Sdk.Model.CashElection.DividendRate

getset

The payment rate for this CashElection.

The payment rate for this CashElection.

ElectionKey

string Lusid.Sdk.Model.CashElection.ElectionKey

getset

Unique key used to identify this election.

Unique key used to identify this election.

ExchangeRate

decimal? Lusid.Sdk.Model.CashElection.ExchangeRate

getset

The exchange rate if this is not the declared CashElection. Defaults to 1 if Election is Declared.

The exchange rate if this is not the declared CashElection. Defaults to 1 if Election is Declared.

IsChosen

bool Lusid.Sdk.Model.CashElection.IsChosen

getset

Has this election been chosen. Only one Election may be Chosen per Event.

Has this election been chosen. Only one Election may be Chosen per Event.

IsDeclared

bool Lusid.Sdk.Model.CashElection.IsDeclared

getset

Is this the declared CashElection. Only one Election may be Declared per Event.

Is this the declared CashElection. Only one Election may be Declared per Event.

IsDefault

bool Lusid.Sdk.Model.CashElection.IsDefault

getset

Is this election the default. Only one Election may be Default per Event

Is this election the default. Only one Election may be Default per Event

---

The documentation for this class was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Model/CashElection.cs