Interface IQueryRunnerHandler

An interface for an entity type that can be used as a RunnerHandlerID in a IQueryRunner

public interface IQueryRunnerHandler

A list of custom instances that can be used by this handler

IEnumerable<KeyValuePair<Guid, string>> CustomHandlerInstanceItems { get; }

Type	Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.Guid, System.String>>

The user friendly name for this type of query runner handler

string HandlerName { get; }

Type	Description
System.String

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

Guid QueryRunnerHandlerTypeID { get; }

Type	Description
System.Guid

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

QueryRunnerHandlerInstanceType RequiresHandlerInstance { get; }

Type	Description
QueryRunnerHandlerInstanceType

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

Task<IEnumerable<ISQLTypeWrapper>> GetParameters(Guid? forHandlerID, UserInfo user, IReadOnlyCache cache, IEntityRetriever retriever)

Type	Name	Description
System.Nullable<System.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
IEntityRetriever	retriever	A context for querying the system

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<ISQLTypeWrapper>>	A list of all the parameters configured against a specific instance of the handler type