Class GetCanvasItems

A helper class for executing the system default GetCanvasItems query

See https://web.lemonedge.com/help/getcanvasitems/ for more information.

Inheritance
System.Object
BaseSQLWrapperExecuter<SQLWrapperExecuter<ICanvasItem>, ICanvasItem>
SQLWrapperExecuter<ICanvasItem>
GetCanvasItems
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.Entities.Helpers.Queries
Assembly: API.dll
Syntax
public class GetCanvasItems : SQLWrapperExecuter<ICanvasItem>

Constructors

GetCanvasItems(IEntityRetriever, IReadOnlyCache)

Creates a new SQLWrapperExecuter for the GetCanvasItems standard SQL Wrapper query

Declaration
public GetCanvasItems(IEntityRetriever retriever, IReadOnlyCache cache)
Parameters
Type Name Description
IEntityRetriever retriever

A IEntityRetriever context for querying the LemonEdge platform
IReadOnlyCache cache

A local cache

Fields

PARAM_CANVASID

The parameter for the canvas to run this query against

Declaration
public static readonly string PARAM_CANVASID
Field Value
Type Description
System.String

QUERYNAME

Global name of the SQLWrapper query that returns all entities that have been modified within a canvas

Declaration
public const string QUERYNAME = "GetCanvasItems"
Field Value
Type Description
System.String

Methods

AddCanvasID(Guid)

Declaration
public override BaseSQLWrapperExecuter<SQLWrapperExecuter<ICanvasItem>, ICanvasItem> AddCanvasID(Guid canvasID)
Parameters
Type Name Description
System.Guid canvasID
Returns
Type Description
BaseSQLWrapperExecuter<SQLWrapperExecuter<ICanvasItem>, ICanvasItem>
Overrides
LemonEdge.API.Entities.Helpers.BaseSQLWrapperExecuter<LemonEdge.API.Entities.Helpers.SQLWrapperExecuter<LemonEdge.API.ComplexTypes.ICanvasItem>, LemonEdge.API.ComplexTypes.ICanvasItem>.AddCanvasID(System.Guid)

AddGetCanvasID(Guid)

Adds the specified canvas id to the parameters for executing this query

Declaration
public GetCanvasItems AddGetCanvasID(Guid canvasID)
Parameters
Type Name Description
System.Guid canvasID

The canvas id to run the GetCanvasItems query with
Returns
Type Description
GetCanvasItems

This GetCanvasItems instance for chaining commands

Execute(IEntityRetriever, IReadOnlyCache, Guid, QueryableExecuter<ICanvasItem>)

Executes the GetCanvasItems system SQLWrapper using the specified parameters, and returns the results of the results of that query

Declaration
public static Task<IEnumerable<ICanvasItem>> Execute(IEntityRetriever retriever, IReadOnlyCache cache, Guid canvasID, QueryableExecuter<ICanvasItem> filter = null)
Parameters
Type Name Description
IEntityRetriever retriever

A IEntityRetriever context for querying the LemonEdge platform
IReadOnlyCache cache

A local cache
System.Guid canvasID

The canvas id to run the GetCanvasItems query with
QueryableExecuter<ICanvasItem> filter

An optional QueryableExecuter<T> that holds any filtering to apply to the query
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<ICanvasItem>>

A task holding the results of executing the GetCanvasItems query with the specified parameters

Execute(Guid, QueryableExecuter<ICanvasItem>)

Executes the GetCanvasItems system SQLWrapper using the specified parameters, and returns the results of the results of that query

Declaration
public Task<IEnumerable<ICanvasItem>> Execute(Guid canvasID, QueryableExecuter<ICanvasItem> filter = null)
Parameters
Type Name Description
System.Guid canvasID

The canvas id to run the GetCanvasItems query with
QueryableExecuter<ICanvasItem> filter

An optional QueryableExecuter<T> that holds any filtering to apply to the query
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<ICanvasItem>>

A task holding the results of executing the GetCanvasItems query with the specified parameters

ExecuteCount(IEntityRetriever, IReadOnlyCache, Guid, QueryableExecuter<ICanvasItem>)

Executes the GetCanvasItems system SQLWrapper using the specified parameters, and returns the count of the results of that query

Declaration
public static Task<int> ExecuteCount(IEntityRetriever retriever, IReadOnlyCache cache, Guid canvasID, QueryableExecuter<ICanvasItem> filter = null)
Parameters
Type Name Description
IEntityRetriever retriever

A IEntityRetriever context for querying the LemonEdge platform
IReadOnlyCache cache

A local cache
System.Guid canvasID

The canvas id to run the GetCanvasItems query with
QueryableExecuter<ICanvasItem> filter

An optional QueryableExecuter<T> that holds any filtering to apply to the query
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

A task holding the count of executing the GetCanvasItems query with the specified parameters

ExecuteCount(Guid, QueryableExecuter<ICanvasItem>)

Executes the GetCanvasItems system SQLWrapper using the specified parameters, and returns the count of the results of that query

Declaration
public Task<int> ExecuteCount(Guid canvasID, QueryableExecuter<ICanvasItem> filter = null)
Parameters
Type Name Description
System.Guid canvasID

The canvas id to run the GetCanvasItems query with
QueryableExecuter<ICanvasItem> filter

An optional QueryableExecuter<T> that holds any filtering to apply to the query
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

A task holding the count of executing the GetCanvasItems query with the specified parameters

ParametersAreValid()

Indicates if the parameters are valid for executing the query

Declaration
protected override bool ParametersAreValid()
Returns
Type Description
System.Boolean

True if the parameters contain a value for @canvasID
Overrides
LemonEdge.API.Entities.Helpers.BaseSQLWrapperExecuter<LemonEdge.API.Entities.Helpers.SQLWrapperExecuter<LemonEdge.API.ComplexTypes.ICanvasItem>, LemonEdge.API.ComplexTypes.ICanvasItem>.ParametersAreValid()

Extension Methods