Class DeleteQueryRunnerHandler
Can be used in a IQueryRunnerStep as a handler for deleting the item
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Reporting.Queries
Assembly: LemonEdge.API.dll
Syntax
public class DeleteQueryRunnerHandler : IQueryRunnerHandlerConstructors
DeleteQueryRunnerHandler()
Declaration
public DeleteQueryRunnerHandler()Fields
PARAM_ID_NAME
The parameter name for the id of the entity instance to delete
Declaration
public const string PARAM_ID_NAME = "@ID"Field Value
| Type | Description |
|---|---|
| string |
UNIQUEID
The unique id for the delete handler
Declaration
public const string UNIQUEID = "9166E6A7-3F16-41F8-B5C7-AAB1D9DCBADB"Field Value
| Type | Description |
|---|---|
| string |
Properties
CustomHandlerInstanceItems
All entity types
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 |
QueryRunnerHandlerTypeID
Indicates this works for the deletion
Declaration
public Guid QueryRunnerHandlerTypeID { get; }Property Value
| Type | Description |
|---|---|
| Guid |
RequiresHandlerInstance
Requires a handler instance - custom
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 all the parameters for deleting an item, the TypeID, and ID
Declaration
public Task<IEnumerable<ISQLTypeWrapper>> GetParameters(Guid? forHandlerID, UserInfo user, IReadOnlyCache cache, IEntityUpdater updater)Parameters
| Type | Name | Description |
|---|---|---|
| Guid? | forHandlerID | The id of the instance, which should always be null for an entity delete |
| UserInfo | user | The logged in user this is running for |
| IReadOnlyCache | cache | A local cache |
| IEntityUpdater | updater | A context for fetching items |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<ISQLTypeWrapper>> | All the parameters for identifying the item to delete |