LUSID C# SDK
Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.PartialClosureConstituent Class Reference

A single constituent of a partial closure event for a Flexible Repo. Contains details of the collateral being exchanged in the Instrument field, represented as a NewInstrument object, as well as the amount being exchanged and the type of that amount (Units or Percentage of current units). More...

Inheritance diagram for Lusid.Sdk.Model.PartialClosureConstituent:
Inheritance graph
[legend]

Public Member Functions

 PartialClosureConstituent (decimal amount=default(decimal), string amountType=default(string), NewInstrument instrument=default(NewInstrument))
 Initializes a new instance of the PartialClosureConstituent 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 (PartialClosureConstituent input)
 Returns true if PartialClosureConstituent instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 PartialClosureConstituent ()
 Initializes a new instance of the PartialClosureConstituent class. More...
 

Properties

decimal Amount [get, set]
 If AmountType is set to Units, this field represents the number of units of the instrument being exchanged. If AmountType is set to Percentage, this field represents the percentage of the total repoed units of the instrument being exchanged. When defining a FlexibleRepoPartialClosureEvent the AmountType can be set to either Units or Percentage, where Units represents the number of units of the instrument being exchanged, and Percentage represents the percentage of the total repoed units of the instrument being exchanged in the context of the FlexibleRepo. More...
 
string AmountType [get, set]
 The type of amount represented by the Amount field. I.e., does it represent a number of units or a percentage of the total repoed units of the instrument? When defining a FlexibleRepoPartialClosureEvent AmountType can be set to either Units or Percentage. Available values: Percentage, Units. More...
 
NewInstrument Instrument [get, set]
 Gets or Sets Instrument More...
 

Detailed Description

A single constituent of a partial closure event for a Flexible Repo. Contains details of the collateral being exchanged in the Instrument field, represented as a NewInstrument object, as well as the amount being exchanged and the type of that amount (Units or Percentage of current units).

Constructor & Destructor Documentation

◆ PartialClosureConstituent() [1/2]

Lusid.Sdk.Model.PartialClosureConstituent.PartialClosureConstituent ( )
inlineprotected

Initializes a new instance of the PartialClosureConstituent class.

◆ PartialClosureConstituent() [2/2]

Lusid.Sdk.Model.PartialClosureConstituent.PartialClosureConstituent ( decimal  amount = default(decimal),
string  amountType = default(string),
NewInstrument  instrument = default(NewInstrument) 
)
inline

Initializes a new instance of the PartialClosureConstituent class.

Parameters
amountIf AmountType is set to Units, this field represents the number of units of the instrument being exchanged. If AmountType is set to Percentage, this field represents the percentage of the total repoed units of the instrument being exchanged. When defining a FlexibleRepoPartialClosureEvent the AmountType can be set to either Units or Percentage, where Units represents the number of units of the instrument being exchanged, and Percentage represents the percentage of the total repoed units of the instrument being exchanged in the context of the FlexibleRepo. (required).
amountTypeThe type of amount represented by the Amount field. I.e., does it represent a number of units or a percentage of the total repoed units of the instrument? When defining a FlexibleRepoPartialClosureEvent AmountType can be set to either Units or Percentage. Available values: Percentage, Units. (required).
instrumentinstrument (required).

Member Function Documentation

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.PartialClosureConstituent.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool Lusid.Sdk.Model.PartialClosureConstituent.Equals ( PartialClosureConstituent  input)
inline

Returns true if PartialClosureConstituent instances are equal

Parameters
inputInstance of PartialClosureConstituent to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.PartialClosureConstituent.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.PartialClosureConstituent.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.PartialClosureConstituent.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Amount

decimal Lusid.Sdk.Model.PartialClosureConstituent.Amount
getset

If AmountType is set to Units, this field represents the number of units of the instrument being exchanged. If AmountType is set to Percentage, this field represents the percentage of the total repoed units of the instrument being exchanged. When defining a FlexibleRepoPartialClosureEvent the AmountType can be set to either Units or Percentage, where Units represents the number of units of the instrument being exchanged, and Percentage represents the percentage of the total repoed units of the instrument being exchanged in the context of the FlexibleRepo.

If AmountType is set to Units, this field represents the number of units of the instrument being exchanged. If AmountType is set to Percentage, this field represents the percentage of the total repoed units of the instrument being exchanged. When defining a FlexibleRepoPartialClosureEvent the AmountType can be set to either Units or Percentage, where Units represents the number of units of the instrument being exchanged, and Percentage represents the percentage of the total repoed units of the instrument being exchanged in the context of the FlexibleRepo.

◆ AmountType

string Lusid.Sdk.Model.PartialClosureConstituent.AmountType
getset

The type of amount represented by the Amount field. I.e., does it represent a number of units or a percentage of the total repoed units of the instrument? When defining a FlexibleRepoPartialClosureEvent AmountType can be set to either Units or Percentage. Available values: Percentage, Units.

The type of amount represented by the Amount field. I.e., does it represent a number of units or a percentage of the total repoed units of the instrument? When defining a FlexibleRepoPartialClosureEvent AmountType can be set to either Units or Percentage. Available values: Percentage, Units.

◆ Instrument

NewInstrument Lusid.Sdk.Model.PartialClosureConstituent.Instrument
getset

Gets or Sets Instrument


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