Class UdListMDOProvider

MDO Provider for 'user-defined' lists, i.e., those that reside in the UDList table. Mandatory additionalInfo is the udListId, which identifies the actual sublist. There is also a dynamic provider that will make a provider called 'udlist<id>, for instance udlist123, where the sublist id is part of the name. Nice if you are in a situation where you can only get a list name and not the additionalInfo as a separate parameter.

Inheritance
object
MDOProviderBase
UdListMDOProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("udlist")]
[MDOAdditionalInfo("UD List id", 1234)]
public class UdListMDOProvider : MDOProviderBase, ISoListProvider, ISoList, IEnumerable<ISoListItem>, IEnumerable

Constructors

UdListMDOProvider()

MDO Provider for 'user-defined' lists, i.e., those that reside in the UDList table. Mandatory additionalInfo is the udListId, which identifies the actual sublist. There is also a dynamic provider that will make a provider called 'udlist<id>, for instance udlist123, where the sublist id is part of the name. Nice if you are in a situation where you can only get a list name and not the additionalInfo as a separate parameter.

Declaration
public UdListMDOProvider()

Fields

ProviderName

MDO Provider for 'user-defined' lists, i.e., those that reside in the UDList table. Mandatory additionalInfo is the udListId, which identifies the actual sublist. There is also a dynamic provider that will make a provider called 'udlist<id>, for instance udlist123, where the sublist id is part of the name. Nice if you are in a situation where you can only get a list name and not the additionalInfo as a separate parameter.

Declaration
public const string ProviderName = "udlist"
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

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

GetGroupingAllowedForListAsync(CancellationToken)

MDO Provider for 'user-defined' lists, i.e., those that reside in the UDList table. Mandatory additionalInfo is the udListId, which identifies the actual sublist. There is also a dynamic provider that will make a provider called 'udlist<id>, for instance udlist123, where the sublist id is part of the name. Nice if you are in a situation where you can only get a list name and not the additionalInfo as a separate parameter.

Declaration
protected override Task<bool> GetGroupingAllowedForListAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<bool>
Overrides

GetItemsAndHeadingsQueryAsync(bool, CancellationToken, params int[])

Intercept the query to add additional restrictions.

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

GetSimpleListQueryAsync(CancellationToken)

Intercept the query to add additional restrictions.

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