Class QueriesQueryableType

An implementation of IQueryableType that returns a QueryableItem for every ISQLWrapper within the entire lemonedge platform

Inheritance
object
QueriesQueryableType
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Reporting.Queries
Assembly: LemonEdge.API.dll
Syntax
public class QueriesQueryableType : IQueryableType

Constructors

QueriesQueryableType()

Declaration
public QueriesQueryableType()

Fields

KEY

Declaration
public const string KEY = "Queries"
Field Value
Type Description
string

Properties

TypeName

Queries

Declaration
public string TypeName { get; }
Property Value
Type Description
string

UserFriendlyName

Queries

Declaration
public string UserFriendlyName { get; }
Property Value
Type Description
string

Methods

CanBeDisplayedInUI(IQueryableItem)

Returns true, as all query queryable items can be displayed in the UI as the ISQLWrapper instance they represent

Declaration
public bool CanBeDisplayedInUI(IQueryableItem item)
Parameters
Type Name Description
IQueryableItem item

A query queryable item
Returns
Type Description
bool

True

GetAll(IReadOnlyCache)

Returns a queryable item for re-querying every ISQLWrapper in the system

Declaration
public Task<IEnumerable<IQueryableItem>> GetAll(IReadOnlyCache cache)
Parameters
Type Name Description
IReadOnlyCache cache

The local cache
Returns
Type Description
Task<IEnumerable<IQueryableItem>>

A queryable item for re-querying every ISQLWrapper in the system

GetItemInfoToDisplayInUI(IQueryableItem)

Returns the entity type ISQLWrapper and the id of the queryable item (The SQL Wrapper instance it represents)

Declaration
public (Type EntityType, Guid ID) GetItemInfoToDisplayInUI(IQueryableItem item)
Parameters
Type Name Description
IQueryableItem item

A query queryable item
Returns
Type Description
(Type EntityType, Guid ID)

The entity type ISQLWrapper and the id of the queryable item (The SQL Wrapper instance it represents)

LoadFromID(IReadOnlyCache, IEntityRetriever, string, string)

Returns a query queryable item for the specified id

Declaration
public Task<IQueryableItem> LoadFromID(IReadOnlyCache cache, IEntityRetriever retriever, string id, string subID = null)
Parameters
Type Name Description
IReadOnlyCache cache

A local cache
IEntityRetriever retriever

A context for retrieving information from the lemonedge system
string id

The id of a Queryable Item
string subID

A sub id for the Queryable Item
Returns
Type Description
Task<IQueryableItem>

A query queryable item for the specified id

Implements

Extension Methods