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

Base class for representing reconciliation rules in LUSID. Reconciliation rules describe how a comparison between two items in the reconciliation should be performed and what constitutes equality. This does not influence WHAT constitutes a match, but only whether once a line has been matched whether an item within it matches another item. If a rule is not given for an item, it will default to equality comparison. This base class should not be directly instantiated; each supported ReconciliationRuleType has a corresponding inherited class. More...

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

Public Types

enum class  RuleTypeEnum { ReconcileNumericRule = 1 , ReconcileDateTimeRule = 2 , ReconcileStringRule = 3 , ReconcileExact = 4 }
 The available values are: ReconcileNumericRule, ReconcileDateTimeRule, ReconcileStringRule, ReconcileExact More...
 

Public Member Functions

 ReconciliationRule (RuleTypeEnum ruleType=default(RuleTypeEnum))
 Initializes a new instance of the ReconciliationRule 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 (ReconciliationRule input)
 Returns true if ReconciliationRule instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 ReconciliationRule ()
 Initializes a new instance of the ReconciliationRule class. More...
 
IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > BaseValidate (ValidationContext validationContext)
 To validate all properties of the instance More...
 

Properties

RuleTypeEnum RuleType [get, set]
 The available values are: ReconcileNumericRule, ReconcileDateTimeRule, ReconcileStringRule, ReconcileExact More...
 

Detailed Description

Base class for representing reconciliation rules in LUSID. Reconciliation rules describe how a comparison between two items in the reconciliation should be performed and what constitutes equality. This does not influence WHAT constitutes a match, but only whether once a line has been matched whether an item within it matches another item. If a rule is not given for an item, it will default to equality comparison. This base class should not be directly instantiated; each supported ReconciliationRuleType has a corresponding inherited class.

Member Enumeration Documentation

◆ RuleTypeEnum

The available values are: ReconcileNumericRule, ReconcileDateTimeRule, ReconcileStringRule, ReconcileExact

The available values are: ReconcileNumericRule, ReconcileDateTimeRule, ReconcileStringRule, ReconcileExact

Enumerator
ReconcileNumericRule 

Enum ReconcileNumericRule for value: ReconcileNumericRule

ReconcileDateTimeRule 

Enum ReconcileDateTimeRule for value: ReconcileDateTimeRule

ReconcileStringRule 

Enum ReconcileStringRule for value: ReconcileStringRule

ReconcileExact 

Enum ReconcileExact for value: ReconcileExact

Constructor & Destructor Documentation

◆ ReconciliationRule() [1/2]

Lusid.Sdk.Model.ReconciliationRule.ReconciliationRule ( )
inlineprotected

Initializes a new instance of the ReconciliationRule class.

◆ ReconciliationRule() [2/2]

Lusid.Sdk.Model.ReconciliationRule.ReconciliationRule ( RuleTypeEnum  ruleType = default(RuleTypeEnum))
inline

Initializes a new instance of the ReconciliationRule class.

Parameters
ruleTypeThe available values are: ReconcileNumericRule, ReconcileDateTimeRule, ReconcileStringRule, ReconcileExact (required).

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if ReconciliationRule instances are equal

Parameters
inputInstance of ReconciliationRule to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

Reimplemented in Lusid.Sdk.Model.ReconcileStringRule, Lusid.Sdk.Model.ReconcileNumericRule, and Lusid.Sdk.Model.ReconcileDateTimeRule.

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ RuleType

RuleTypeEnum Lusid.Sdk.Model.ReconciliationRule.RuleType
getset

The available values are: ReconcileNumericRule, ReconcileDateTimeRule, ReconcileStringRule, ReconcileExact

The available values are: ReconcileNumericRule, ReconcileDateTimeRule, ReconcileStringRule, ReconcileExact


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