Class GetGLRollup
A helper class for executing the system default GetGLRollup query
See https://web.lemonedge.com/help/getglrollup-sql-wrapper/ for more information.
Inheritance
Inherited Members
Namespace: LemonEdge.API.Entities.Helpers.Queries
Assembly: API.dll
Syntax
public class GetGLRollup : SQLWrapperExecuter<IGLRollupInfo>Constructors
GetGLRollup(IEntityRetriever, IReadOnlyCache)
Creates a new SQLWrapperExecuter for the GetGLRollup standard SQL Wrapper query
Declaration
public GetGLRollup(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_GLROLLUP
The ParameterName for the GLRollupID parameter
Declaration
public const string PARAM_GLROLLUP = "@glRollupID"Field Value
| Type | Description |
|---|---|
| System.String |
PARAM_PERIODEND
The ParameterName for the PeriodEndID parameter
Declaration
public const string PARAM_PERIODEND = "@periodEndID"Field Value
| Type | Description |
|---|---|
| System.String |
QUERYNAME
Global name of the SQLWrapper query
Declaration
public const string QUERYNAME = "GetGLRollup"Field Value
| Type | Description |
|---|---|
| System.String |
Methods
AddGLRollupID(Guid)
The GL Rollup you want to use to generate the structure of this report against the specified Period End data
Declaration
public GetGLRollup AddGLRollupID(Guid glRollupID)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | glRollupID | The gl rollup id to run the GetGLRollup query with |
Returns
| Type | Description |
|---|---|
| GetGLRollup | This GetGLRollup instance for chaining commands |
AddPeriodEndID(Guid)
The period end you want to run this report against
Declaration
public GetGLRollup AddPeriodEndID(Guid periodEndID)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | periodEndID | The period end id to run the GetGLRollup query with |
Returns
| Type | Description |
|---|---|
| GetGLRollup | This GetGLRollup instance for chaining commands |
Execute(IEntityRetriever, IReadOnlyCache, Guid, Guid, QueryableExecuter<IGLRollupInfo>)
Executes the GetGLRollup system SQLWrapper using the specified parameters, and returns the results of the results of that query
Declaration
public static Task<IEnumerable<IGLRollupInfo>> Execute(IEntityRetriever retriever, IReadOnlyCache cache, Guid periodEndID, Guid glRollupID, QueryableExecuter<IGLRollupInfo> filter = null)Parameters
| Type | Name | Description |
|---|---|---|
| IEntityRetriever | retriever | A IEntityRetriever context for querying the LemonEdge platform |
| IReadOnlyCache | cache | A local cache |
| System.Guid | periodEndID | The period end you want to run this report against |
| System.Guid | glRollupID | The GL Rollup you want to use to generate the structure of this report against the specified Period End data |
| QueryableExecuter<IGLRollupInfo> | 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<IGLRollupInfo>> | A task holding the results of executing the GetGLRollup query with the specified parameters |
Execute(Guid, Guid, QueryableExecuter<IGLRollupInfo>)
Executes the GetGLRollup system SQLWrapper using the specified parameters, and returns the results of the results of that query
Declaration
public Task<IEnumerable<IGLRollupInfo>> Execute(Guid periodEndID, Guid glRollupID, QueryableExecuter<IGLRollupInfo> filter = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | periodEndID | The period end you want to run this report against |
| System.Guid | glRollupID | The GL Rollup you want to use to generate the structure of this report against the specified Period End data |
| QueryableExecuter<IGLRollupInfo> | 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<IGLRollupInfo>> | A task holding the results of executing the GetGLRollup 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 @periodEndID, and @glRollupID |