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

Specification for the reconciliation request. Left and Right hand sides are constructed. Each consists of a valuation of a portfolio using an aggregation request. The results of this can then be compared to each other. The difference, which is effectively a risk based difference allows comparison of the effects of changing a recipe, valuation date, or (though it may or may not make logical sense) a portfolio. For instance, one might look at the difference in risk caused by the addition of transaction to a portfolio, or through changing the valuation methodology or system. More...

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

Public Member Functions

 ReconciliationRequest (ValuationRequest left=default(ValuationRequest), ValuationRequest right=default(ValuationRequest), List< ReconciliationLeftRightAddressKeyPair > leftToRightMapping=default(List< ReconciliationLeftRightAddressKeyPair >), List< ReconciliationRule > comparisonRules=default(List< ReconciliationRule >), List< string > preserveKeys=default(List< string >))
 Initializes a new instance of the ReconciliationRequest 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 (ReconciliationRequest input)
 Returns true if ReconciliationRequest instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

ValuationRequest Left [get, set]
 Gets or Sets Left More...
 
ValuationRequest Right [get, set]
 Gets or Sets Right More...
 
List< ReconciliationLeftRightAddressKeyPairLeftToRightMapping [get, set]
 The mapping from property keys requested by left aggregation to property keys on right hand side More...
 
List< ReconciliationRuleComparisonRules [get, set]
 The set of rules to be used in comparing values. These are the rules that determine what constitues a match. The simplest is obviously an exact one-for-one comparison, but tolerances on numerical or date time values and case-insensitive string comparison are supported amongst other types. More...
 
List< string > PreserveKeys [get, set]
 List of keys to preserve (from rhs) in the diff. Used in conjunction with filtering/grouping. If two values are equal, for a given key then the value is elided from the results. Setting it here will preserve it (takes the values from the RHS and puts it into the line by line results). More...
 

Detailed Description

Specification for the reconciliation request. Left and Right hand sides are constructed. Each consists of a valuation of a portfolio using an aggregation request. The results of this can then be compared to each other. The difference, which is effectively a risk based difference allows comparison of the effects of changing a recipe, valuation date, or (though it may or may not make logical sense) a portfolio. For instance, one might look at the difference in risk caused by the addition of transaction to a portfolio, or through changing the valuation methodology or system.

Constructor & Destructor Documentation

◆ ReconciliationRequest() [1/2]

Lusid.Sdk.Model.ReconciliationRequest.ReconciliationRequest ( )
inlineprotected

Initializes a new instance of the ReconciliationRequest class.

◆ ReconciliationRequest() [2/2]

Lusid.Sdk.Model.ReconciliationRequest.ReconciliationRequest ( ValuationRequest  left = default(ValuationRequest),
ValuationRequest  right = default(ValuationRequest),
List< ReconciliationLeftRightAddressKeyPair leftToRightMapping = default(List<ReconciliationLeftRightAddressKeyPair>),
List< ReconciliationRule comparisonRules = default(List<ReconciliationRule>),
List< string >  preserveKeys = default(List<string>) 
)
inline

Initializes a new instance of the ReconciliationRequest class.

Parameters
leftleft (required).
rightright (required).
leftToRightMappingThe mapping from property keys requested by left aggregation to property keys on right hand side.
comparisonRulesThe set of rules to be used in comparing values. These are the rules that determine what constitues a match. The simplest is obviously an exact one-for-one comparison, but tolerances on numerical or date time values and case-insensitive string comparison are supported amongst other types..
preserveKeysList of keys to preserve (from rhs) in the diff. Used in conjunction with filtering/grouping. If two values are equal, for a given key then the value is elided from the results. Setting it here will preserve it (takes the values from the RHS and puts it into the line by line results)..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if ReconciliationRequest instances are equal

Parameters
inputInstance of ReconciliationRequest to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ ComparisonRules

List<ReconciliationRule> Lusid.Sdk.Model.ReconciliationRequest.ComparisonRules
getset

The set of rules to be used in comparing values. These are the rules that determine what constitues a match. The simplest is obviously an exact one-for-one comparison, but tolerances on numerical or date time values and case-insensitive string comparison are supported amongst other types.

The set of rules to be used in comparing values. These are the rules that determine what constitues a match. The simplest is obviously an exact one-for-one comparison, but tolerances on numerical or date time values and case-insensitive string comparison are supported amongst other types.

◆ Left

ValuationRequest Lusid.Sdk.Model.ReconciliationRequest.Left
getset

Gets or Sets Left

◆ LeftToRightMapping

List<ReconciliationLeftRightAddressKeyPair> Lusid.Sdk.Model.ReconciliationRequest.LeftToRightMapping
getset

The mapping from property keys requested by left aggregation to property keys on right hand side

The mapping from property keys requested by left aggregation to property keys on right hand side

◆ PreserveKeys

List<string> Lusid.Sdk.Model.ReconciliationRequest.PreserveKeys
getset

List of keys to preserve (from rhs) in the diff. Used in conjunction with filtering/grouping. If two values are equal, for a given key then the value is elided from the results. Setting it here will preserve it (takes the values from the RHS and puts it into the line by line results).

List of keys to preserve (from rhs) in the diff. Used in conjunction with filtering/grouping. If two values are equal, for a given key then the value is elided from the results. Setting it here will preserve it (takes the values from the RHS and puts it into the line by line results).

◆ Right

ValuationRequest Lusid.Sdk.Model.ReconciliationRequest.Right
getset

Gets or Sets Right


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