Class EntityDescriptorQueryableType
An implementation of IQueryableType that returns a QueryableItem for each entity within the entire LemonEdge platform
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Queryable
Assembly: LemonEdge.API.dll
Syntax
public class EntityDescriptorQueryableType : IQueryableTypeConstructors
EntityDescriptorQueryableType()
Declaration
public EntityDescriptorQueryableType()Fields
KEY
Declaration
public const string KEY = "Entities"Field Value
| Type | Description |
|---|---|
| string |
Properties
TypeName
Entities
Declaration
public string TypeName { get; }Property Value
| Type | Description |
|---|---|
| string |
UserFriendlyName
Entities
Declaration
public string UserFriendlyName { get; }Property Value
| Type | Description |
|---|---|
| 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 |
|---|---|
| bool | 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 |
|---|---|
| Task<IEnumerable<IQueryableItem>> | A queryable item for querying all information of every EntityDescriptor in the system |
GetItemInfoToDisplayInUI(IQueryableItem)
Not supported - 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 |
|---|---|
| (Type EntityType, Guid ID) |
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 |
| string | id | The id of a Queryable Item |
| string | subID | A sub id for the Queryable Item |
Returns
| Type | Description |
|---|---|
| Task<IQueryableItem> | An entity queryable item for the specified id |