Class DeleteQueryRunnerHandler

Can be used in a IQueryRunnerStep as a handler for deleting the item

Inheritance
System.Object
DeleteQueryRunnerHandler
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 DeleteQueryRunnerHandler : IQueryRunnerHandler

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
System.String

UNIQUEID

The unique id for the delete handler

Declaration
public const string UNIQUEID = "9166E6A7-3F16-41F8-B5C7-AAB1D9DCBADB"
Field Value
Type Description
System.String

Properties

CustomHandlerInstanceItems

All entity types

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 deletion

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

RequiresHandlerInstance

Requires a handler instance - custom

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

Methods

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

Returns all the parameters for deleting an item, the TypeID, and 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 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
IEntityRetriever retriever

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

All the parameters for identifying the item to delete

Implements

Extension Methods