Class AuditHistoryQueryableType
An implementation of IQueryableType that returns QueryableItems for being able to query all audit information within the entire lemonedge platform
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Reporting.Queries
Assembly: LemonEdge.API.dll
Syntax
public class AuditHistoryQueryableType : IQueryableType
Constructors
AuditHistoryQueryableType()
Declaration
public AuditHistoryQueryableType()
Fields
KEY
Declaration
public const string KEY = "AuditHistories"
Field Value
Type | Description |
---|---|
string |
Properties
TypeName
AuditHistories
Declaration
public string TypeName { get; }
Property Value
Type | Description |
---|---|
string |
UserFriendlyName
Audit History
Declaration
public string UserFriendlyName { get; }
Property Value
Type | Description |
---|---|
string |
Methods
CanBeDisplayedInUI(IQueryableItem)
Audit 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 audit queryable item |
Returns
Type | Description |
---|---|
bool | False |
GetAll(IReadOnlyCache)
Returns a queryable item for querying the audit history 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 the audit history 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 audit queryable item |
Returns
Type | Description |
---|---|
(Type EntityType, Guid ID) |
LoadFromID(IReadOnlyCache, IEntityRetriever, string, string)
Returns an audit 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 audit queryable item for the specified id |