Class GetInstrumentCapitalAccountDataSettings
A helper class for executing the system default GetInstrumentCapitalAccountDataSettings query
See https://help.lemonedge.com/getinstrumentcapitalaccountdatasettings/ for more information.
Inheritance
Inherited Members
Namespace: LemonEdge.API.Core.FinancialServices.Helpers
Assembly: LemonEdge.API.Core.FinancialServices.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 |
---|---|
string |
Methods
AddInstrumentID(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 |
---|---|---|
Guid? | instrumentID | The instrument id to run the GetInstrumentCapitalAccountDataSettings query with |
Returns
Type | Description |
---|---|
GetInstrumentCapitalAccountDataSettings | This GetInstrumentCapitalAccountDataSettings instance for chaining commands |
Execute(IEntityRetriever, IReadOnlyCache, 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 |
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 |
---|---|
Task<IEnumerable<IInstrumentCapitalAccountDataSettingResult>> | A task holding the results of executing the GetInstrumentCapitalAccountDataSettings query with the specified parameters |
Execute(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 |
---|---|---|
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 |
---|---|
Task<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 |
---|---|
bool | True if the parameters contain a value for @instrumentID |