Class GetInstrumentCapitalAccountDataSettings

A helper class for executing the system default GetInstrumentCapitalAccountDataSettings query

See https://web.lemonedge.com/help/getinstrumentcapitalaccountdatasettings/ for more information.

Inheritance
System.Object
BaseSQLWrapperExecuter<SQLWrapperExecuter<IInstrumentCapitalAccountDataSettingResult>, IInstrumentCapitalAccountDataSettingResult>
SQLWrapperExecuter<IInstrumentCapitalAccountDataSettingResult>
GetInstrumentCapitalAccountDataSettings
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: LemonEdge.API.Entities.Helpers.Queries
Assembly: API.dll
Syntax
public class GetInstrumentCapitalAccountDataSettings : SQLWrapperExecuter<IInstrumentCapitalAccountDataSettingResult>

Constructors

GetInstrumentCapitalAccountDataSettings(IEntityRetriever, IReadOnlyCache)

Creates a new SQLWrapperExecuter for the GetInstrumentCapitalAccountDataSettings standard SQL Wrapper query

Declaration
public GetInstrumentCapitalAccountDataSettings(IEntityRetriever retriever, IReadOnlyCache cache)
Parameters
Type Name Description
IEntityRetriever retriever

A IEntityRetriever context for querying the LemonEdge platform
IReadOnlyCache cache

A local cache

Fields

QUERYNAME

Global name of the SQLWrapper query

Declaration
public const string QUERYNAME = "GetInstrumentCapitalAccountDataSettings"
Field Value
Type Description
System.String

Methods

AddInstrumentID(Nullable<Guid>)

The ID of the instrument to return the capital account data settings for. If null it will return all instruments with settings.

Declaration
public GetInstrumentCapitalAccountDataSettings AddInstrumentID(Guid? instrumentID)
Parameters
Type Name Description
System.Nullable<System.Guid> instrumentID

The instrument id to run the GetInstrumentCapitalAccountDataSettings query with
Returns
Type Description
GetInstrumentCapitalAccountDataSettings

This GetInstrumentCapitalAccountDataSettings instance for chaining commands

Execute(IEntityRetriever, IReadOnlyCache, Nullable<Guid>, QueryableExecuter<IInstrumentCapitalAccountDataSettingResult>)

Executes the GetInstrumentCapitalAccountDataSettings system SQLWrapper using the specified parameters, and returns the results of the results of that query

Declaration
public static Task<IEnumerable<IInstrumentCapitalAccountDataSettingResult>> Execute(IEntityRetriever retriever, IReadOnlyCache cache, Guid? instrumentID, QueryableExecuter<IInstrumentCapitalAccountDataSettingResult> filter = null)
Parameters
Type Name Description
IEntityRetriever retriever

A IEntityRetriever context for querying the LemonEdge platform
IReadOnlyCache cache

A local cache
System.Nullable<System.Guid> instrumentID

The ID of the instrument to return the capital account data settings for. If null it will return all instruments with settings.
QueryableExecuter<IInstrumentCapitalAccountDataSettingResult> filter

An optional QueryableExecuter<T> that holds any filtering to apply to the query
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<IInstrumentCapitalAccountDataSettingResult>>

A task holding the results of executing the GetInstrumentCapitalAccountDataSettings query with the specified parameters

Execute(Nullable<Guid>, QueryableExecuter<IInstrumentCapitalAccountDataSettingResult>)

Executes the GetInstrumentCapitalAccountDataSettings system SQLWrapper using the specified parameters, and returns the results of the results of that query

Declaration
public Task<IEnumerable<IInstrumentCapitalAccountDataSettingResult>> Execute(Guid? instrumentID, QueryableExecuter<IInstrumentCapitalAccountDataSettingResult> filter = null)
Parameters
Type Name Description
System.Nullable<System.Guid> instrumentID

The ID of the instrument to return the capital account data settings for. If null it will return all instruments with settings.
QueryableExecuter<IInstrumentCapitalAccountDataSettingResult> filter

An optional QueryableExecuter<T> that holds any filtering to apply to the query
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<IInstrumentCapitalAccountDataSettingResult>>

A task holding the results of executing the GetInstrumentCapitalAccountDataSettings query with the specified parameters

ParametersAreValid()

Indicates if the parameters are valid for executing the query

Declaration
protected override bool ParametersAreValid()
Returns
Type Description
System.Boolean

True if the parameters contain a value for @instrumentID
Overrides
LemonEdge.API.Entities.Helpers.BaseSQLWrapperExecuter<LemonEdge.API.Entities.Helpers.SQLWrapperExecuter<LemonEdge.API.ComplexTypes.IInstrumentCapitalAccountDataSettingResult>, LemonEdge.API.ComplexTypes.IInstrumentCapitalAccountDataSettingResult>.ParametersAreValid()

Extension Methods