Class EntityDescriptorQueryableType

An implementation of IQueryableType that returns a QueryableItem for each entity within the entire lemonedge platform

Inheritance
System.Object
EntityDescriptorQueryableType
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 EntityDescriptorQueryableType : IQueryableType

Fields

KEY

Declaration
public const string KEY = "Entities"
Field Value
Type Description
System.String

Properties

TypeName

Entities

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

UserFriendlyName

Entities

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

Methods

CanBeDisplayedInUI(IQueryableItem)

Entity Queryable Items can not be displayed in the UI - always returns false

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

An entity queryable item
Returns
Type Description
System.Boolean

False

GetAll(IReadOnlyCache)

Returns a queryable item for querying all information of every EntityDescriptor in the system

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

The local cache
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<IQueryableItem>>

A queryable item for querying all information of every EntityDescriptor in the system

GetItemInfoToDisplayInUI(IQueryableItem)

Not implemented - throws an exception as CanBeDisplayedInUI(IQueryableItem) returns false

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

An entity queryable item
Returns
Type Description
System.ValueTuple<System.Type, System.Guid>

LoadFromID(IReadOnlyCache, IEntityRetriever, String, String)

Returns an entity 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
System.String id

The id of a Queryable Item
System.String subID

A sub id for the Queryable Item
Returns
Type Description
System.Threading.Tasks.Task<IQueryableItem>

An entity queryable item for the specified id

Implements

Extension Methods