Class WebPanelProvider

List of WebPanels visible possible for use with groups and headings.

Inheritance
object
MDOProviderBase
WebPanelProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("WebPanel")]
public class WebPanelProvider : MDOProviderBase, ISoListProvider, ISoList, IEnumerable<ISoListItem>, IEnumerable

Constructors

WebPanelProvider()

List of WebPanels visible possible for use with groups and headings.

Declaration
public WebPanelProvider()

Fields

ProviderName

The name of the provider.

Declaration
public const string ProviderName = "WebPanel"
Field Value
Type Description
string

Properties

HistoryInfo

History information for the supported list

Declaration
public override HistoryInfo HistoryInfo { get; }
Property Value
Type Description
HistoryInfo
Overrides

Methods

AddGroupLinkJoin(int[], CustomSearch)

List of WebPanels visible possible for use with groups and headings.

Declaration
protected override void AddGroupLinkJoin(int[] selectedIds, ListTableRows.CustomSearch query)
Parameters
Type Name Description
int[] selectedIds
ListTableRows.CustomSearch query
Overrides

ConstructAsync(string, string, int[], bool, string, bool, CancellationToken)

Initializes all class members.

Declaration
public override Task ConstructAsync(string tableName, string additionalInfo, int[] historyIDs, bool onlyReadHistory, string searchValue, bool forceFlatList, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string tableName

Name of the table holding the MDO list values, like Category, Business, etc. Note that this really has to be a valid table name.
string additionalInfo
int[] historyIDs

List of history id's (primary keys of the table holding the MDO list values).
bool onlyReadHistory

Only read history nodes.
string searchValue

Search value (case insensetive string used like '%[searchValue]%'. The result when using this is allways a flat list without hisotry elements.
bool forceFlatList

State that a forced flat list should be returned.
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides

GetItemExtraInfo(ListTableRow)

List of WebPanels visible possible for use with groups and headings.

Declaration
protected override string GetItemExtraInfo(ListTableRow row)
Parameters
Type Name Description
ListTableRow row
Returns
Type Description
string
Overrides

GetItemType(ListTableRow)

Get a value for the field Type in ISoList for an item element

Declaration
protected override string GetItemType(ListTableRow row)
Parameters
Type Name Description
ListTableRow row

The actual row for which the item is created
Returns
Type Description
string

The type of the list item
Overrides

GetItemsAndHeadingsQueryAsync(bool, CancellationToken, params int[])

Create a query for for reading the items and headings of a list.

Declaration
protected override Task<ListTableRows.CustomSearch> GetItemsAndHeadingsQueryAsync(bool bFlattened, CancellationToken cancellationToken, params int[] selectedIds)
Parameters
Type Name Description
bool bFlattened

Force the list to be flattened.
CancellationToken cancellationToken
int[] selectedIds

Id's in the list that will be forced to be included, regardless of other filtering.
Returns
Type Description
Task<ListTableRows.CustomSearch>

Query for reading the items and headdings of a list.
Overrides
Remarks

The _listInfo is populated.

The resulting query will contain an OR clause in the grouplink join if selectedIds != null: 
select distinct c.* from crm5.category c inner join crm5.categorygrouplink cg
on c.category_id = cg.category_id and
(cg.group_id = 1 or cg.category_id in (1,2,3))
This works as long as we do not fetch any of the fields from the grouplink table (that would break the distinct clause and cause unwanted row multiplication).

GetSimpleListQueryAsync(CancellationToken)

List of WebPanels visible possible for use with groups and headings.

Declaration
protected override Task<ListTableRows.CustomSearch> GetSimpleListQueryAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ListTableRows.CustomSearch>
Overrides

Implements

Extension Methods