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

Result class for a cash flow value More...

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

Public Member Functions

 CashFlowValue (DateTimeOffset paymentDate=default(DateTimeOffset), ResultValueDictionary diagnostics=default(ResultValueDictionary), CashFlowLineage cashFlowLineage=default(CashFlowLineage), decimal paymentAmount=default(decimal), string paymentCcy=default(string), ResultValueTypeEnum resultValueType=default(ResultValueTypeEnum))
 Initializes a new instance of the CashFlowValue class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
override 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 (CashFlowValue input)
 Returns true if CashFlowValue instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
- Public Member Functions inherited from Lusid.Sdk.Model.ResultValue
 ResultValue (ResultValueTypeEnum resultValueType=default(ResultValueTypeEnum))
 Initializes a new instance of the ResultValue class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
override bool Equals (object input)
 Returns true if objects are equal More...
 
bool Equals (ResultValue input)
 Returns true if ResultValue instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 CashFlowValue ()
 Initializes a new instance of the CashFlowValue class. More...
 
IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > BaseValidate (ValidationContext validationContext)
 To validate all properties of the instance More...
 
- Protected Member Functions inherited from Lusid.Sdk.Model.ResultValue
 ResultValue ()
 Initializes a new instance of the ResultValue class. More...
 
IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > BaseValidate (ValidationContext validationContext)
 To validate all properties of the instance More...
 

Properties

DateTimeOffset PaymentDate [get, set]
 The payment date of the cash flow More...
 
ResultValueDictionary Diagnostics [get, set]
 Gets or Sets Diagnostics More...
 
CashFlowLineage CashFlowLineage [get, set]
 Gets or Sets CashFlowLineage More...
 
decimal PaymentAmount [get, set]
 The amount paid or received More...
 
string PaymentCcy [get, set]
 The currency of the transaction More...
 
- Properties inherited from Lusid.Sdk.Model.ResultValue
ResultValueTypeEnum ResultValueType [get, set]
 The available values are: ResultValue, ResultValueDictionary, ResultValue0D, ResultValueDecimal, ResultValueInt, ResultValueString, ResultValueBool, ResultValueCurrency, CashFlowValue, CashFlowValueSet, ResultValueLifeCycleEventValue, ResultValueDateTimeOffset More...
 

Additional Inherited Members

- Public Types inherited from Lusid.Sdk.Model.ResultValue
enum class  ResultValueTypeEnum {
  ResultValue = 1 , ResultValueDictionary = 2 , ResultValue0D = 3 , ResultValueDecimal = 4 ,
  ResultValueInt = 5 , ResultValueString = 6 , ResultValueBool = 7 , ResultValueCurrency = 8 ,
  CashFlowValue = 9 , CashFlowValueSet = 10 , ResultValueLifeCycleEventValue = 11 , ResultValueDateTimeOffset = 12
}
 The available values are: ResultValue, ResultValueDictionary, ResultValue0D, ResultValueDecimal, ResultValueInt, ResultValueString, ResultValueBool, ResultValueCurrency, CashFlowValue, CashFlowValueSet, ResultValueLifeCycleEventValue, ResultValueDateTimeOffset More...
 

Detailed Description

Result class for a cash flow value

Constructor & Destructor Documentation

◆ CashFlowValue() [1/2]

Lusid.Sdk.Model.CashFlowValue.CashFlowValue ( )
inlineprotected

Initializes a new instance of the CashFlowValue class.

◆ CashFlowValue() [2/2]

Lusid.Sdk.Model.CashFlowValue.CashFlowValue ( DateTimeOffset  paymentDate = default(DateTimeOffset),
ResultValueDictionary  diagnostics = default(ResultValueDictionary),
CashFlowLineage  cashFlowLineage = default(CashFlowLineage),
decimal  paymentAmount = default(decimal),
string  paymentCcy = default(string),
ResultValueTypeEnum  resultValueType = default(ResultValueTypeEnum) 
)
inline

Initializes a new instance of the CashFlowValue class.

Parameters
paymentDateThe payment date of the cash flow (required).
diagnosticsdiagnostics.
cashFlowLineagecashFlowLineage.
paymentAmountThe amount paid or received (required).
paymentCcyThe currency of the transaction (required).
resultValueTypeThe available values are: ResultValue, ResultValueDictionary, ResultValue0D, ResultValueDecimal, ResultValueInt, ResultValueString, ResultValueBool, ResultValueCurrency, CashFlowValue, CashFlowValueSet, ResultValueLifeCycleEventValue, ResultValueDateTimeOffset (required) (default to "CashFlowValue").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.CashFlowValue.BaseValidate ( ValidationContext  validationContext)
inlineprotected

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if CashFlowValue instances are equal

Parameters
inputInstance of CashFlowValue to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

override string Lusid.Sdk.Model.CashFlowValue.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.ResultValue.

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ CashFlowLineage

CashFlowLineage Lusid.Sdk.Model.CashFlowValue.CashFlowLineage
getset

Gets or Sets CashFlowLineage

◆ Diagnostics

ResultValueDictionary Lusid.Sdk.Model.CashFlowValue.Diagnostics
getset

Gets or Sets Diagnostics

◆ PaymentAmount

decimal Lusid.Sdk.Model.CashFlowValue.PaymentAmount
getset

The amount paid or received

The amount paid or received

◆ PaymentCcy

string Lusid.Sdk.Model.CashFlowValue.PaymentCcy
getset

The currency of the transaction

The currency of the transaction

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.CashFlowValue.PaymentDate
getset

The payment date of the cash flow

The payment date of the cash flow


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