Lusid.Sdk.Model.TransactionQueryParameters Class Reference

TransactionQueryParameters More...

Inheritance diagram for Lusid.Sdk.Model.TransactionQueryParameters:

Public Types
enum class	QueryModeEnum { TradeDate = 1 , SettleDate = 2 }
	The date to compare against the upper and lower bounds for the effective datetime or cut label. Defaults to 'TradeDate' if not specified. The available values are: TradeDate, SettleDate More...

Public Member Functions
	TransactionQueryParameters (DateTimeOrCutLabel startDate=default(DateTimeOrCutLabel), DateTimeOrCutLabel endDate=default(DateTimeOrCutLabel), QueryModeEnum? queryMode=default(QueryModeEnum?), bool showCancelledTransactions=default(bool))
	Initializes a new instance of the TransactionQueryParameters 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 (TransactionQueryParameters input)
	Returns true if TransactionQueryParameters instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	TransactionQueryParameters ()
	Initializes a new instance of the TransactionQueryParameters class. More...

Properties
QueryModeEnum?	QueryMode [get, set]
	The date to compare against the upper and lower bounds for the effective datetime or cut label. Defaults to 'TradeDate' if not specified. The available values are: TradeDate, SettleDate More...
DateTimeOrCutLabel	StartDate [get, set]
	The lower bound effective datetime or cut label (inclusive) from which to build the transactions. More...
DateTimeOrCutLabel	EndDate [get, set]
	The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. More...
bool	ShowCancelledTransactions [get, set]
	Option to specify whether or not to include cancelled transactions in the output. Defaults to False if not specified. More...

Detailed Description

TransactionQueryParameters

Member Enumeration Documentation

QueryModeEnum

enum Lusid.Sdk.Model.TransactionQueryParameters.QueryModeEnum

strong

The date to compare against the upper and lower bounds for the effective datetime or cut label. Defaults to 'TradeDate' if not specified. The available values are: TradeDate, SettleDate

The date to compare against the upper and lower bounds for the effective datetime or cut label. Defaults to 'TradeDate' if not specified. The available values are: TradeDate, SettleDate

Enumerator
TradeDate	Enum TradeDate for value: TradeDate
SettleDate	Enum SettleDate for value: SettleDate

Constructor & Destructor Documentation

TransactionQueryParameters() [1/2]

Lusid.Sdk.Model.TransactionQueryParameters.TransactionQueryParameters ( )

inlineprotected

Initializes a new instance of the TransactionQueryParameters class.

TransactionQueryParameters() [2/2]

Lusid.Sdk.Model.TransactionQueryParameters.TransactionQueryParameters ( DateTimeOrCutLabel  startDate = default(DateTimeOrCutLabel), DateTimeOrCutLabel  endDate = default(DateTimeOrCutLabel), QueryModeEnum?  queryMode = default(QueryModeEnum?), bool  showCancelledTransactions = default(bool)  )

inline

Initializes a new instance of the TransactionQueryParameters class.

Parameters

startDate	The lower bound effective datetime or cut label (inclusive) from which to build the transactions. (required).
endDate	The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. (required).
queryMode	The date to compare against the upper and lower bounds for the effective datetime or cut label. Defaults to 'TradeDate' if not specified. The available values are: TradeDate, SettleDate.
showCancelledTransactions	Option to specify whether or not to include cancelled transactions in the output. Defaults to False if not specified..

Member Function Documentation

Equals() [1/2]

override bool Lusid.Sdk.Model.TransactionQueryParameters.Equals ( object  input )

inline

Returns true if objects are equal

Parameters

input

Object to be compared

Returns

Boolean

Equals() [2/2]

bool Lusid.Sdk.Model.TransactionQueryParameters.Equals ( TransactionQueryParameters  input )

inline

Returns true if TransactionQueryParameters instances are equal

Parameters

input

Instance of TransactionQueryParameters to be compared

Returns

Boolean

GetHashCode()

override int Lusid.Sdk.Model.TransactionQueryParameters.GetHashCode ( )

inline

Gets the hash code

Returns

Hash code

ToJson()

virtual string Lusid.Sdk.Model.TransactionQueryParameters.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

override string Lusid.Sdk.Model.TransactionQueryParameters.ToString ( )

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

EndDate

DateTimeOrCutLabel Lusid.Sdk.Model.TransactionQueryParameters.EndDate

getset

The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions.

The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions.

QueryMode

QueryModeEnum? Lusid.Sdk.Model.TransactionQueryParameters.QueryMode

getset

The date to compare against the upper and lower bounds for the effective datetime or cut label. Defaults to 'TradeDate' if not specified. The available values are: TradeDate, SettleDate

The date to compare against the upper and lower bounds for the effective datetime or cut label. Defaults to 'TradeDate' if not specified. The available values are: TradeDate, SettleDate

ShowCancelledTransactions

bool Lusid.Sdk.Model.TransactionQueryParameters.ShowCancelledTransactions

getset

Option to specify whether or not to include cancelled transactions in the output. Defaults to False if not specified.

Option to specify whether or not to include cancelled transactions in the output. Defaults to False if not specified.

StartDate

DateTimeOrCutLabel Lusid.Sdk.Model.TransactionQueryParameters.StartDate

getset

The lower bound effective datetime or cut label (inclusive) from which to build the transactions.

The lower bound effective datetime or cut label (inclusive) from which to build the transactions.

---

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/TransactionQueryParameters.cs