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

Comparison of string values More...

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

Public Types

enum class  ComparisonTypeEnum {
  Exact = 1 , Contains = 2 , CaseInsensitive = 3 , ContainsAnyCase = 4 ,
  IsOneOf = 5
}
 The available values are: Exact, Contains, CaseInsensitive, ContainsAnyCase, IsOneOf More...
 
- Public Types inherited from Lusid.Sdk.Model.ReconciliationRule
enum class  RuleTypeEnum { ReconcileNumericRule = 1 , ReconcileDateTimeRule = 2 , ReconcileStringRule = 3 , ReconcileExact = 4 }
 The available values are: ReconcileNumericRule, ReconcileDateTimeRule, ReconcileStringRule, ReconcileExact More...
 

Public Member Functions

 ReconcileStringRule (ComparisonTypeEnum comparisonType=default(ComparisonTypeEnum), Dictionary< string, List< string >> oneOfCandidates=default(Dictionary< string, List< string >>), AggregateSpec appliesTo=default(AggregateSpec), RuleTypeEnum ruleType=default(RuleTypeEnum))
 Initializes a new instance of the ReconcileStringRule 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 (ReconcileStringRule input)
 Returns true if ReconcileStringRule instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
- Public Member Functions inherited from Lusid.Sdk.Model.ReconciliationRule
 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...
 
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

 ReconcileStringRule ()
 Initializes a new instance of the ReconcileStringRule 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.ReconciliationRule
 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

ComparisonTypeEnum ComparisonType [get, set]
 The available values are: Exact, Contains, CaseInsensitive, ContainsAnyCase, IsOneOf More...
 
Dictionary< string, List< string > > OneOfCandidates [get, set]
 For cases of &quot;IsOneOf&quot; a set is required to match values against. Fuzzy matching of strings against one of a set. There can be cases where systems &quot;A&quot; and &quot;B&quot; might use different terms for the same logical entity. A common case would be comparison of something like a day count fraction where some convention like the &quot;actual 365&quot; convention might be represented as one of [&quot;A365&quot;, &quot;Act365&quot;, &quot;Actual365&quot;] or similar. This is to allow this kind of fuzzy matching of values. Note that as this is exhaustive comparison across sets it will be slow and should therefore be used sparingly. More...
 
AggregateSpec AppliesTo [get, set]
 Gets or Sets AppliesTo More...
 
- Properties inherited from Lusid.Sdk.Model.ReconciliationRule
RuleTypeEnum RuleType [get, set]
 The available values are: ReconcileNumericRule, ReconcileDateTimeRule, ReconcileStringRule, ReconcileExact More...
 

Detailed Description

Comparison of string values

Member Enumeration Documentation

◆ ComparisonTypeEnum

The available values are: Exact, Contains, CaseInsensitive, ContainsAnyCase, IsOneOf

The available values are: Exact, Contains, CaseInsensitive, ContainsAnyCase, IsOneOf

Enumerator
Exact 

Enum Exact for value: Exact

Contains 

Enum Contains for value: Contains

CaseInsensitive 

Enum CaseInsensitive for value: CaseInsensitive

ContainsAnyCase 

Enum ContainsAnyCase for value: ContainsAnyCase

IsOneOf 

Enum IsOneOf for value: IsOneOf

Constructor & Destructor Documentation

◆ ReconcileStringRule() [1/2]

Lusid.Sdk.Model.ReconcileStringRule.ReconcileStringRule ( )
inlineprotected

Initializes a new instance of the ReconcileStringRule class.

◆ ReconcileStringRule() [2/2]

Lusid.Sdk.Model.ReconcileStringRule.ReconcileStringRule ( ComparisonTypeEnum  comparisonType = default(ComparisonTypeEnum),
Dictionary< string, List< string >>  oneOfCandidates = default(Dictionary<string, List<string>>),
AggregateSpec  appliesTo = default(AggregateSpec),
RuleTypeEnum  ruleType = default(RuleTypeEnum) 
)
inline

Initializes a new instance of the ReconcileStringRule class.

Parameters
comparisonTypeThe available values are: Exact, Contains, CaseInsensitive, ContainsAnyCase, IsOneOf (required).
oneOfCandidatesFor cases of &quot;IsOneOf&quot; a set is required to match values against. Fuzzy matching of strings against one of a set. There can be cases where systems &quot;A&quot; and &quot;B&quot; might use different terms for the same logical entity. A common case would be comparison of something like a day count fraction where some convention like the &quot;actual 365&quot; convention might be represented as one of [&quot;A365&quot;, &quot;Act365&quot;, &quot;Actual365&quot;] or similar. This is to allow this kind of fuzzy matching of values. Note that as this is exhaustive comparison across sets it will be slow and should therefore be used sparingly..
appliesToappliesTo (required).
ruleTypeThe available values are: ReconcileNumericRule, ReconcileDateTimeRule, ReconcileStringRule, ReconcileExact (required) (default to "ReconcileStringRule").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.ReconcileStringRule.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.ReconcileStringRule.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if ReconcileStringRule instances are equal

Parameters
inputInstance of ReconcileStringRule to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.ReconciliationRule.

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AppliesTo

AggregateSpec Lusid.Sdk.Model.ReconcileStringRule.AppliesTo
getset

Gets or Sets AppliesTo

◆ ComparisonType

ComparisonTypeEnum Lusid.Sdk.Model.ReconcileStringRule.ComparisonType
getset

The available values are: Exact, Contains, CaseInsensitive, ContainsAnyCase, IsOneOf

The available values are: Exact, Contains, CaseInsensitive, ContainsAnyCase, IsOneOf

◆ OneOfCandidates

Dictionary<string, List<string> > Lusid.Sdk.Model.ReconcileStringRule.OneOfCandidates
getset

For cases of &quot;IsOneOf&quot; a set is required to match values against. Fuzzy matching of strings against one of a set. There can be cases where systems &quot;A&quot; and &quot;B&quot; might use different terms for the same logical entity. A common case would be comparison of something like a day count fraction where some convention like the &quot;actual 365&quot; convention might be represented as one of [&quot;A365&quot;, &quot;Act365&quot;, &quot;Actual365&quot;] or similar. This is to allow this kind of fuzzy matching of values. Note that as this is exhaustive comparison across sets it will be slow and should therefore be used sparingly.

For cases of &quot;IsOneOf&quot; a set is required to match values against. Fuzzy matching of strings against one of a set. There can be cases where systems &quot;A&quot; and &quot;B&quot; might use different terms for the same logical entity. A common case would be comparison of something like a day count fraction where some convention like the &quot;actual 365&quot; convention might be represented as one of [&quot;A365&quot;, &quot;Act365&quot;, &quot;Actual365&quot;] or similar. This is to allow this kind of fuzzy matching of values. Note that as this is exhaustive comparison across sets it will be slow and should therefore be used sparingly.


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