Class APIRunnerHandler
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Reporting.Queries
Assembly: LemonEdge.API.dll
Syntax
public class APIRunnerHandler : IQueryRunnerHandlerConstructors
APIRunnerHandler()
Declaration
public APIRunnerHandler()Fields
UNIQUEID
Declaration
public const string UNIQUEID = "3BAEE541-7DD1-4C9D-9F4F-5CCC7634ADF9"Field Value
| Type | Description |
|---|---|
| string |
Properties
CustomHandlerInstanceItems
A list of custom instances that can be used by this handler
Declaration
public IEnumerable<KeyValuePair<Guid, string>> CustomHandlerInstanceItems { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<KeyValuePair<Guid, string>> |
HandlerName
The user friendly name for this type of query runner handler
Declaration
public string HandlerName { get; }Property Value
| Type | Description |
|---|---|
| string |
IncludeAllSQLRowResultsAsParamValues
Declaration
public bool IncludeAllSQLRowResultsAsParamValues { get; }Property Value
| Type | Description |
|---|---|
| bool |
QueryRunnerHandlerTypeID
The unique type of this handler. Can be a TypeID of the entity that can be used in a IQueryRunnerStep, or a unique id if no instance is required
Declaration
public Guid QueryRunnerHandlerTypeID { get; }Property Value
| Type | Description |
|---|---|
| Guid |
RequiresHandlerInstance
Indicates the type of instance required for use by this handler.
None indicates none, Entity indicates an instance of an entity of type QueryRunnerHandlerTypeID, and custom indicates an instance from CustomHandlerInstanceItems
Declaration
public QueryRunnerHandlerInstanceType RequiresHandlerInstance { get; }Property Value
| Type | Description |
|---|---|
| QueryRunnerHandlerInstanceType |
SettingsType
Declaration
public Type SettingsType { get; }Property Value
| Type | Description |
|---|---|
| Type |
Methods
GetParameters(Guid?, UserInfo, IReadOnlyCache, IEntityUpdater)
Returns a list of all the parameters configured against a specific instance of the handler type
For instance if this is a handler for ISQLWrapper, it would return all the parameters for the sql wrapper
Declaration
public Task<IEnumerable<ISQLTypeWrapper>> GetParameters(Guid? forHandlerID, UserInfo user, IReadOnlyCache cache, IEntityUpdater updater)Parameters
| Type | Name | Description |
|---|---|---|
| Guid? | forHandlerID | The instance of the entity id that is a handler for a IQueryRunnerStep |
| UserInfo | user | The logged in user this is running for |
| IReadOnlyCache | cache | A local cache |
| IEntityUpdater | updater |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<ISQLTypeWrapper>> | A list of all the parameters configured against a specific instance of the handler type |