Lusid.Sdk.Model.SecurityElection Class Reference

Security election for Events that result in equity More...

Inheritance diagram for Lusid.Sdk.Model.SecurityElection:

Public Member Functions
	SecurityElection (string electionKey=default(string), bool isChosen=default(bool), bool isDefault=default(bool), decimal? price=default(decimal?), UnitsRatio unitsRatio=default(UnitsRatio))
	Initializes a new instance of the SecurityElection 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 (SecurityElection input)
	Returns true if SecurityElection instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...

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

Properties
string	ElectionKey [get, set]
	Unique key associated to this election. More...
bool	IsChosen [get, set]
	Is this the election that has been explicitly chosen from multiple options. More...
bool	IsDefault [get, set]
	Is this election automatically applied in the absence of an election having been made. May only be true for one election if multiple are provided. More...
decimal?	Price [get, set]
	Price per unit of the security. At least one of UnitsRatio or Price must be provided. Price must non-zero. More...
UnitsRatio	UnitsRatio [get, set]
	Gets or Sets UnitsRatio More...

Detailed Description

Security election for Events that result in equity

Constructor & Destructor Documentation

SecurityElection() [1/2]

Lusid.Sdk.Model.SecurityElection.SecurityElection ( )

inlineprotected

Initializes a new instance of the SecurityElection class.

SecurityElection() [2/2]

Lusid.Sdk.Model.SecurityElection.SecurityElection ( string  electionKey = default(string), bool  isChosen = default(bool), bool  isDefault = default(bool), decimal?  price = default(decimal?), UnitsRatio  unitsRatio = default(UnitsRatio)  )

inline

Initializes a new instance of the SecurityElection class.

Parameters

electionKey	Unique key associated to this election. (required).
isChosen	Is this the election that has been explicitly chosen from multiple options..
isDefault	Is this election automatically applied in the absence of an election having been made. May only be true for one election if multiple are provided..
price	Price per unit of the security. At least one of UnitsRatio or Price must be provided. Price must non-zero..
unitsRatio	unitsRatio.

Member Function Documentation

Equals() [1/2]

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

inline

Returns true if objects are equal

Parameters

input

Object to be compared

Returns

Boolean

Equals() [2/2]

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

inline

Returns true if SecurityElection instances are equal

Parameters

input

Instance of SecurityElection to be compared

Returns

Boolean

GetHashCode()

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

inline

Gets the hash code

Returns

Hash code

ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

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

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

ElectionKey

string Lusid.Sdk.Model.SecurityElection.ElectionKey

getset

Unique key associated to this election.

Unique key associated to this election.

IsChosen

bool Lusid.Sdk.Model.SecurityElection.IsChosen

getset

Is this the election that has been explicitly chosen from multiple options.

Is this the election that has been explicitly chosen from multiple options.

IsDefault

bool Lusid.Sdk.Model.SecurityElection.IsDefault

getset

Is this election automatically applied in the absence of an election having been made. May only be true for one election if multiple are provided.

Is this election automatically applied in the absence of an election having been made. May only be true for one election if multiple are provided.

Price

decimal? Lusid.Sdk.Model.SecurityElection.Price

getset

Price per unit of the security. At least one of UnitsRatio or Price must be provided. Price must non-zero.

Price per unit of the security. At least one of UnitsRatio or Price must be provided. Price must non-zero.

UnitsRatio

UnitsRatio Lusid.Sdk.Model.SecurityElection.UnitsRatio

getset

Gets or Sets UnitsRatio

---

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/SecurityElection.cs