Base class for representing result key rules in LUSID, which describe how to resolve (unit) result data. This base class should not be directly instantiated; each supported ResultKeyRuleType has a corresponding inherited class. More...
Public Types | |
| enum class | ResultKeyRuleTypeEnum { Invalid = 1 , ResultDataKeyRule = 2 , PortfolioResultDataKeyRule = 3 } |
| Available values: Invalid, ResultDataKeyRule, PortfolioResultDataKeyRule. More... | |
Public Member Functions | |
| ResultKeyRule (ResultKeyRuleTypeEnum resultKeyRuleType=default(ResultKeyRuleTypeEnum)) | |
| Initializes a new instance of the ResultKeyRule 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 (ResultKeyRule input) |
| Returns true if ResultKeyRule instances are equal More... | |
| override int | GetHashCode () |
| Gets the hash code More... | |
Protected Member Functions | |
| ResultKeyRule () | |
| Initializes a new instance of the ResultKeyRule class. More... | |
| IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > | BaseValidate (ValidationContext validationContext) |
| To validate all properties of the instance More... | |
Properties | |
| ResultKeyRuleTypeEnum | ResultKeyRuleType [get, set] |
| Available values: Invalid, ResultDataKeyRule, PortfolioResultDataKeyRule. More... | |
Detailed Description
Base class for representing result key rules in LUSID, which describe how to resolve (unit) result data. This base class should not be directly instantiated; each supported ResultKeyRuleType has a corresponding inherited class.
Member Enumeration Documentation
◆ ResultKeyRuleTypeEnum
Available values: Invalid, ResultDataKeyRule, PortfolioResultDataKeyRule.
Available values: Invalid, ResultDataKeyRule, PortfolioResultDataKeyRule.
| Enumerator | |
|---|---|
| Invalid | Enum Invalid for value: Invalid |
| ResultDataKeyRule | Enum ResultDataKeyRule for value: ResultDataKeyRule |
| PortfolioResultDataKeyRule | Enum PortfolioResultDataKeyRule for value: PortfolioResultDataKeyRule |
Constructor & Destructor Documentation
◆ ResultKeyRule() [1/2]
|
inlineprotected |
Initializes a new instance of the ResultKeyRule class.
◆ ResultKeyRule() [2/2]
|
inline |
Initializes a new instance of the ResultKeyRule class.
- Parameters
-
resultKeyRuleType Available values: Invalid, ResultDataKeyRule, PortfolioResultDataKeyRule. (required).
Member Function Documentation
◆ BaseValidate()
|
inlineprotected |
To validate all properties of the instance
- Parameters
-
validationContext Validation context
- Returns
- Validation Result
◆ Equals() [1/2]
|
inline |
Returns true if objects are equal
- Parameters
-
input Object to be compared
- Returns
- Boolean
◆ Equals() [2/2]
|
inline |
Returns true if ResultKeyRule instances are equal
- Parameters
-
input Instance of ResultKeyRule to be compared
- Returns
- Boolean
◆ GetHashCode()
|
inline |
Gets the hash code
- Returns
- Hash code
◆ ToJson()
|
inlinevirtual |
Returns the JSON string presentation of the object
- Returns
- JSON string presentation of the object
Reimplemented in Lusid.Sdk.Model.ResultDataKeyRule, and Lusid.Sdk.Model.PortfolioResultDataKeyRule.
◆ ToString()
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
Property Documentation
◆ ResultKeyRuleType
|
getset |
Available values: Invalid, ResultDataKeyRule, PortfolioResultDataKeyRule.
Available values: Invalid, ResultDataKeyRule, PortfolioResultDataKeyRule.
The documentation for this class was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Model/ResultKeyRule.cs
