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

ComplianceRunInfo More...

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

Public Member Functions

 ComplianceRunInfo (string runId=default(string), DateTimeOffset instigatedAt=default(DateTimeOffset), DateTimeOffset completedAt=default(DateTimeOffset), string schedule=default(string), bool allRulesPassed=default(bool), bool hasResults=default(bool), DateTimeOffset asAt=default(DateTimeOffset))
 Initializes a new instance of the ComplianceRunInfo 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 (ComplianceRunInfo input)
 Returns true if ComplianceRunInfo instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

string RunId [get, set]
 The unique identifier of a compliance run More...
 
DateTimeOffset InstigatedAt [get, set]
 The time the compliance run was launched (e.g. button pressed). Currently it is also both the as at and effective at time in whichthe rule set and portfolio data (including any pending trades if the run is pretrade) is taken for the caluation, although it may be possible to run compliance for historical effective at and as at dates in the future. More...
 
DateTimeOffset CompletedAt [get, set]
 The time the compliance run calculation was completed More...
 
string Schedule [get, set]
 Whether the compliance run was pre or post trade More...
 
bool AllRulesPassed [get, set]
 True if all rules passed, for all the portfolios they were assigned to More...
 
bool HasResults [get, set]
 False when no results have been returned eg. when no rules exist More...
 
DateTimeOffset AsAt [get, set]
 Legacy AsAt time for backwards compatibility More...
 

Detailed Description

ComplianceRunInfo

Constructor & Destructor Documentation

◆ ComplianceRunInfo() [1/2]

Lusid.Sdk.Model.ComplianceRunInfo.ComplianceRunInfo ( )
inlineprotected

Initializes a new instance of the ComplianceRunInfo class.

◆ ComplianceRunInfo() [2/2]

Lusid.Sdk.Model.ComplianceRunInfo.ComplianceRunInfo ( string  runId = default(string),
DateTimeOffset  instigatedAt = default(DateTimeOffset),
DateTimeOffset  completedAt = default(DateTimeOffset),
string  schedule = default(string),
bool  allRulesPassed = default(bool),
bool  hasResults = default(bool),
DateTimeOffset  asAt = default(DateTimeOffset) 
)
inline

Initializes a new instance of the ComplianceRunInfo class.

Parameters
runIdThe unique identifier of a compliance run (required).
instigatedAtThe time the compliance run was launched (e.g. button pressed). Currently it is also both the as at and effective at time in whichthe rule set and portfolio data (including any pending trades if the run is pretrade) is taken for the caluation, although it may be possible to run compliance for historical effective at and as at dates in the future. (required).
completedAtThe time the compliance run calculation was completed (required).
scheduleWhether the compliance run was pre or post trade (required).
allRulesPassedTrue if all rules passed, for all the portfolios they were assigned to (required).
hasResultsFalse when no results have been returned eg. when no rules exist (required).
asAtLegacy AsAt time for backwards compatibility (required).

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if ComplianceRunInfo instances are equal

Parameters
inputInstance of ComplianceRunInfo to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AllRulesPassed

bool Lusid.Sdk.Model.ComplianceRunInfo.AllRulesPassed
getset

True if all rules passed, for all the portfolios they were assigned to

True if all rules passed, for all the portfolios they were assigned to

◆ AsAt

DateTimeOffset Lusid.Sdk.Model.ComplianceRunInfo.AsAt
getset

Legacy AsAt time for backwards compatibility

Legacy AsAt time for backwards compatibility

◆ CompletedAt

DateTimeOffset Lusid.Sdk.Model.ComplianceRunInfo.CompletedAt
getset

The time the compliance run calculation was completed

The time the compliance run calculation was completed

◆ HasResults

bool Lusid.Sdk.Model.ComplianceRunInfo.HasResults
getset

False when no results have been returned eg. when no rules exist

False when no results have been returned eg. when no rules exist

◆ InstigatedAt

DateTimeOffset Lusid.Sdk.Model.ComplianceRunInfo.InstigatedAt
getset

The time the compliance run was launched (e.g. button pressed). Currently it is also both the as at and effective at time in whichthe rule set and portfolio data (including any pending trades if the run is pretrade) is taken for the caluation, although it may be possible to run compliance for historical effective at and as at dates in the future.

The time the compliance run was launched (e.g. button pressed). Currently it is also both the as at and effective at time in whichthe rule set and portfolio data (including any pending trades if the run is pretrade) is taken for the caluation, although it may be possible to run compliance for historical effective at and as at dates in the future.

◆ RunId

string Lusid.Sdk.Model.ComplianceRunInfo.RunId
getset

The unique identifier of a compliance run

The unique identifier of a compliance run

◆ Schedule

string Lusid.Sdk.Model.ComplianceRunInfo.Schedule
getset

Whether the compliance run was pre or post trade

Whether the compliance run was pre or post trade


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