Interface IVennSetProcessor
A processor used for loading and processing a IVennSet from the UI across multiple views in a consistent manner
See https://web.lemonedge.com/help/vennsets/ for more information
Inherited Members
Namespace: LemonEdge.API.Processors
Assembly: API.dll
Syntax
public interface IVennSetProcessor : IBaseDataSetProcessorWithDBSave, IBaseDataSetProcessor, IProcessor, IDisposable
Properties
FieldInfos
The list of field info records that describe what produced a specified column ISQLTypeWrapper record.
This links the queryable item field GetFields(IReadOnlyCache) to the corrosponding column holding the value result
Declaration
IEnumerable<IVennSetQueryableItemFieldInfo> FieldInfos { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IVennSetQueryableItemFieldInfo> |
Filters
A list of all the filter records to be applied to the vennset results
Declaration
IEnumerable<IFilterDescriptor> Filters { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IFilterDescriptor> |
VennSet
The root vennset item this processor is responsible for
Declaration
IVennSet VennSet { get; }
Property Value
Type | Description |
---|---|
IVennSet |
VennSetQueryableItems
The list of items that are being queried by this vennset
Declaration
IEnumerable<IVennsetQueryableItem> VennSetQueryableItems { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IVennsetQueryableItem> |
Wrapper
The ISQLWrapper that backs this vennset and holds the automatically created sql
Declaration
ISQLWrapper Wrapper { get; }
Property Value
Type | Description |
---|---|
ISQLWrapper |
Methods
GetQueryableItem(Guid)
Returns an instance of the actual queryable item for the specified IVennsetQueryableItem
Declaration
IQueryableItem GetQueryableItem(Guid forDataSourceQueryableItemID)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | forDataSourceQueryableItemID | The IVennsetQueryableItem to return an instance of the actual queryable item for |
Returns
Type | Description |
---|---|
IQueryableItem | An instance of the actual queryable item for the specified IVennsetQueryableItem |
GetQueryableItemFields(Guid)
Returns all the possible field items for the specified IVennsetQueryableItem
Declaration
IEnumerable<IQueryableFieldInfo> GetQueryableItemFields(Guid forDataSourceQueryableItemID)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | forDataSourceQueryableItemID | The IVennsetQueryableItem to return all the possible field items for |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IQueryableFieldInfo> | All the possible field items for the specified IVennsetQueryableItem |
GetQueryableItemParams(Guid)
Returns all the possible parameters for the specified IVennsetQueryableItem
Declaration
IEnumerable<IQueryableParamInfo> GetQueryableItemParams(Guid forDataSourceQueryableItemID)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | forDataSourceQueryableItemID | The IVennsetQueryableItem to return all the possible parameters for |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IQueryableParamInfo> | All the possible parameters for the specified IVennsetQueryableItem |
GetTotalQueriedEntities()
Returns all the entities that are queried in this vennset and any sub-vennsets
Declaration
IEnumerable<EntityDescriptor> GetTotalQueriedEntities()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<EntityDescriptor> | All the entities that are queried in this vennset and any sub-vennsets |
GetWrapperTypes(IVennsetQueryableItem)
Returns the collection of ISQLTypeWrapper that are for the column results of the specified IVennSetQueryableItemFieldInfo
Declaration
IEnumerable<ISQLTypeWrapper> GetWrapperTypes(IVennsetQueryableItem item)
Parameters
Type | Name | Description |
---|---|---|
IVennsetQueryableItem | item | The sql type wrappers defining the columns for this queryable item |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ISQLTypeWrapper> | The collection of ISQLTypeWrapper that are for the column results of the specified IVennSetQueryableItemFieldInfo |
GetWrapperTypes(SQLTypeWrapperType)
Returns the collection of ISQLTypeWrapper that are for the parameters or column results of this vennset (and thus in turn the ISQLWrapper itself)
Declaration
IEnumerable<ISQLTypeWrapper> GetWrapperTypes(SQLTypeWrapperType type)
Parameters
Type | Name | Description |
---|---|---|
SQLTypeWrapperType | type | The type of sql type wrappers to return - either for the parameters or columns |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ISQLTypeWrapper> | The collection of ISQLTypeWrapper that are for the parameters or column results of this vennset |
OnAddFieldInfo(IVennSetQueryableItemFieldInfo)
Adds the specified queryable item field info record to this vennset
Declaration
void OnAddFieldInfo(IVennSetQueryableItemFieldInfo item)
Parameters
Type | Name | Description |
---|---|---|
IVennSetQueryableItemFieldInfo | item | The queryable item field info to add to this vennset |
OnAddFilter(IVennsetQueryableItem, IFilterDescriptor)
Adds the specified filter descriptor to this vennset
Declaration
void OnAddFilter(IVennsetQueryableItem forQueryableItem, IFilterDescriptor filter)
Parameters
Type | Name | Description |
---|---|---|
IVennsetQueryableItem | forQueryableItem | Adds the filter to the specified queryable item |
IFilterDescriptor | filter |
OnAddQueryableItem(IVennsetQueryableItem)
Adds the specified queryable item record to this vennset
Declaration
Task OnAddQueryableItem(IVennsetQueryableItem item)
Parameters
Type | Name | Description |
---|---|---|
IVennsetQueryableItem | item | The queryable item to add to this vennset |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A task indicating the completion of the operation |
OnAddWrapperType(ISQLTypeWrapper)
Adds the specified sql wrapper type record, of either a column, parameter, or queryable item, for the vennset and thus the underlying sqlwrapper too
Declaration
void OnAddWrapperType(ISQLTypeWrapper item)
Parameters
Type | Name | Description |
---|---|---|
ISQLTypeWrapper | item | The specified sql wrapper type record, of either a column, parameter, or queryable item, for the vennset and thus the underlying sqlwrapper too |
OnAddWrapperType(IVennsetQueryableItem, ISQLTypeWrapper)
Adds the specified sql wrapper type record, for the queryable item, indicating the result from that set to use
Declaration
void OnAddWrapperType(IVennsetQueryableItem forQueryableItem, ISQLTypeWrapper item)
Parameters
Type | Name | Description |
---|---|---|
IVennsetQueryableItem | forQueryableItem | The queryable item to use this column from |
ISQLTypeWrapper | item | The specified sql wrapper type record, for the queryable item, indicating the result from that set to use |
OnDeleteFieldInfo(IVennSetQueryableItemFieldInfo)
Deletes the specified queryable item field info record from this vennset
Declaration
void OnDeleteFieldInfo(IVennSetQueryableItemFieldInfo item)
Parameters
Type | Name | Description |
---|---|---|
IVennSetQueryableItemFieldInfo | item | The queryable item field info to remove from this vennset |
OnDeleteFilter(IFilterDescriptor)
Deletes the specified filter descriptor from this vennset
Declaration
void OnDeleteFilter(IFilterDescriptor filter)
Parameters
Type | Name | Description |
---|---|---|
IFilterDescriptor | filter |
OnDeleteQueryableItem(IVennsetQueryableItem)
Deletes the specified queryable item record from this vennset
Declaration
void OnDeleteQueryableItem(IVennsetQueryableItem item)
Parameters
Type | Name | Description |
---|---|---|
IVennsetQueryableItem | item | The queryable item to remove from this vennset |
OnDeleteWrapperType(ISQLTypeWrapper)
Deletes the specified sql wrapper type record, of either a column, parameter, or queryable item, from the vennset and thus the underlying sqlwrapper too
Declaration
void OnDeleteWrapperType(ISQLTypeWrapper item)
Parameters
Type | Name | Description |
---|---|---|
ISQLTypeWrapper | item | The sql type wrapper record for a column or parameter of this vennset |