Class ReportQueryRunnerHandler

Indicates that IReport can be used in a IQueryRunnerStep as a handler for generating reports

Inheritance
System.Object
ReportQueryRunnerHandler
Implements
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.Queries
Assembly: API.dll
Syntax
public class ReportQueryRunnerHandler : IQueryRunnerHandler

Properties

CustomHandlerInstanceItems

Not implemented

Declaration
public IEnumerable<KeyValuePair<Guid, string>> CustomHandlerInstanceItems { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.Guid, System.String>>

HandlerName

The user friendly name for this type of query runner handler

Declaration
public string HandlerName { get; }
Property Value
Type Description
System.String

QueryRunnerHandlerTypeID

Indicates this works for the IReport entity type

Declaration
public Guid QueryRunnerHandlerTypeID { get; }
Property Value
Type Description
System.Guid

RequiresHandlerInstance

Requires a handler instance - Entity Reports

Declaration
public QueryRunnerHandlerInstanceType RequiresHandlerInstance { get; }
Property Value
Type Description
QueryRunnerHandlerInstanceType

Methods

GetParameters(Nullable<Guid>, UserInfo, IReadOnlyCache, IEntityRetriever)

Returns all the parameters against a given IReport id

Declaration
public Task<IEnumerable<ISQLTypeWrapper>> GetParameters(Guid? forHandlerID, UserInfo user, IReadOnlyCache cache, IEntityRetriever retriever)
Parameters
Type Name Description
System.Nullable<System.Guid> forHandlerID

The id of a IReport
UserInfo user

The logged in user this is running for
IReadOnlyCache cache

A local cache
IEntityRetriever retriever

A context for querying the system
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<ISQLTypeWrapper>>

All the parameters against a given IReport id

Implements

Extension Methods