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

Options for controlling the default aspects and behaviour of the aggregation. More...

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

Public Member Functions

 AggregationOptions (bool useAnsiLikeSyntax=default(bool), bool allowPartialEntitlementSuccess=default(bool), bool applyIso4217Rounding=default(bool))
 Initializes a new instance of the AggregationOptions 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 (AggregationOptions input)
 Returns true if AggregationOptions instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Properties

bool UseAnsiLikeSyntax [get, set]
 Should the aggregation behave like ANSI Sql or MySql with respect to a conceptual request which is equivalent to "select a,sum(a) from results"; ANSI Sql would report an error if a was not unique where MySql would simply view a,suma(a) as equivalent to firstof(a),sum(a). More...
 
bool AllowPartialEntitlementSuccess [get, set]
 In the case of valuing a portfolio group where some, but not all entitlements fail, should the aggregation return the valuations applied only to those portfolios where entitlements checks succeeded. More...
 
bool ApplyIso4217Rounding [get, set]
 Various results that are units of currency might need to be rounded. This will round according to the ISO4217 standard number of decimal places for a currency. More...
 

Detailed Description

Options for controlling the default aspects and behaviour of the aggregation.

Constructor & Destructor Documentation

◆ AggregationOptions()

Lusid.Sdk.Model.AggregationOptions.AggregationOptions ( bool  useAnsiLikeSyntax = default(bool),
bool  allowPartialEntitlementSuccess = default(bool),
bool  applyIso4217Rounding = default(bool) 
)
inline

Initializes a new instance of the AggregationOptions class.

Parameters
useAnsiLikeSyntaxShould the aggregation behave like ANSI Sql or MySql with respect to a conceptual request which is equivalent to "select a,sum(a) from results"; ANSI Sql would report an error if a was not unique where MySql would simply view a,suma(a) as equivalent to firstof(a),sum(a)..
allowPartialEntitlementSuccessIn the case of valuing a portfolio group where some, but not all entitlements fail, should the aggregation return the valuations applied only to those portfolios where entitlements checks succeeded..
applyIso4217RoundingVarious results that are units of currency might need to be rounded. This will round according to the ISO4217 standard number of decimal places for a currency..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if AggregationOptions instances are equal

Parameters
inputInstance of AggregationOptions to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AllowPartialEntitlementSuccess

bool Lusid.Sdk.Model.AggregationOptions.AllowPartialEntitlementSuccess
getset

In the case of valuing a portfolio group where some, but not all entitlements fail, should the aggregation return the valuations applied only to those portfolios where entitlements checks succeeded.

In the case of valuing a portfolio group where some, but not all entitlements fail, should the aggregation return the valuations applied only to those portfolios where entitlements checks succeeded.

◆ ApplyIso4217Rounding

bool Lusid.Sdk.Model.AggregationOptions.ApplyIso4217Rounding
getset

Various results that are units of currency might need to be rounded. This will round according to the ISO4217 standard number of decimal places for a currency.

Various results that are units of currency might need to be rounded. This will round according to the ISO4217 standard number of decimal places for a currency.

◆ UseAnsiLikeSyntax

bool Lusid.Sdk.Model.AggregationOptions.UseAnsiLikeSyntax
getset

Should the aggregation behave like ANSI Sql or MySql with respect to a conceptual request which is equivalent to "select a,sum(a) from results"; ANSI Sql would report an error if a was not unique where MySql would simply view a,suma(a) as equivalent to firstof(a),sum(a).

Should the aggregation behave like ANSI Sql or MySql with respect to a conceptual request which is equivalent to "select a,sum(a) from results"; ANSI Sql would report an error if a was not unique where MySql would simply view a,suma(a) as equivalent to firstof(a),sum(a).


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