Class GetInstrumentSets
A helper class for executing the system default GetPaths query
See https://web.lemonedge.com/help/getinstrumentsets/ for more information.
Inheritance
Inherited Members
Namespace: LemonEdge.API.Entities.Helpers.Queries
Assembly: API.dll
Syntax
public class GetInstrumentSets : SQLWrapperExecuter<IInstrumentSetInfo>Constructors
GetInstrumentSets(IEntityRetriever, IReadOnlyCache)
Creates a new SQLWrapperExecuter for the GetInstrumentSets standard SQL Wrapper query
Declaration
public GetInstrumentSets(IEntityRetriever retriever, IReadOnlyCache cache)Parameters
| Type | Name | Description |
|---|---|---|
| IEntityRetriever | retriever | A IEntityRetriever context for querying the LemonEdge platform |
| IReadOnlyCache | cache | A local cache |
Fields
PARAM_INSTRUMENTSETID
The ParameterName for the InstrumentSetID parameter
Declaration
public const string PARAM_INSTRUMENTSETID = "@instrumentSetID"Field Value
| Type | Description |
|---|---|
| System.String |
QUERYNAME
Global name of the SQLWrapper query
Declaration
public const string QUERYNAME = "GetInstrumentSets"Field Value
| Type | Description |
|---|---|
| System.String |
Methods
AddInstrumentSetID(Guid)
Indicates only to use allocations that have an effective date less than or equal to this. This would exclude new allocations, or transfers depending on the date
Declaration
public GetInstrumentSets AddInstrumentSetID(Guid instrumentSetID)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | instrumentSetID | The ID of the instrument set to return all matching instruments for. If null it will return all instrument sets and the instruments that belong to them. |
Returns
| Type | Description |
|---|---|
| GetInstrumentSets | This GetInstrumentSets instance for chaining commands |
Execute(IEntityRetriever, IReadOnlyCache, Guid, QueryableExecuter<IInstrumentSetInfo>)
Executes the GetInstrumentSets system SQLWrapper using the specified parameters, and returns the results of the results of that query
Declaration
public static Task<IEnumerable<IInstrumentSetInfo>> Execute(IEntityRetriever retriever, IReadOnlyCache cache, Guid instrumentSetID, QueryableExecuter<IInstrumentSetInfo> filter = null)Parameters
| Type | Name | Description |
|---|---|---|
| IEntityRetriever | retriever | A IEntityRetriever context for querying the LemonEdge platform |
| IReadOnlyCache | cache | A local cache |
| System.Guid | instrumentSetID | Indicates only to use allocations that have an effective date less than or equal to this. This would exclude new allocations, or transfers depending on the date |
| QueryableExecuter<IInstrumentSetInfo> | 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<IInstrumentSetInfo>> | A task holding the results of executing the GetInstrumentSets query with the specified parameters |
Execute(Guid, QueryableExecuter<IInstrumentSetInfo>)
Executes the GetInstrumentSets system SQLWrapper using the specified parameters, and returns the results of the results of that query
Declaration
public Task<IEnumerable<IInstrumentSetInfo>> Execute(Guid instrumentSetID, QueryableExecuter<IInstrumentSetInfo> filter = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | instrumentSetID | Indicates only to use allocations that have an effective date less than or equal to this. This would exclude new allocations, or transfers depending on the date |
| QueryableExecuter<IInstrumentSetInfo> | 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<IInstrumentSetInfo>> | A task holding the results of executing the GetInstrumentSets 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 @instrumentSetID |