Class WebPanelGroupProvider

List of WebPanels with visible for groups as commaseperated ids in extrainfo field. This list only makes sence if the setting use groups and heading are turned on for

Inheritance
object
AnyTableListProviderBase
WebPanelGroupProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("WebPanelGroup")]
public class WebPanelGroupProvider : AnyTableListProviderBase, ISoListProvider, ISoList

Constructors

WebPanelGroupProvider()

List of WebPanels with visible for groups as commaseperated ids in extrainfo field. This list only makes sence if the setting use groups and heading are turned on for

Declaration
public WebPanelGroupProvider()

Fields

ProviderName

The name of the provider.

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

Properties

TableInfo

The main table info of the query. This is used by subclasses (e.g. this class) when restricting history data.

Declaration
protected override TableInfo TableInfo { get; }
Property Value
Type Description
TableInfo
Overrides

Methods

ExecuteQueryAsync(Select, List<ISoListItem>, CancellationToken)

Execute the query in the database.

Declaration
protected override Task ExecuteQueryAsync(Select sql, List<ISoListItem> resultCollection, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Select sql

The query to execute in the database.
List<ISoListItem> resultCollection

Collection holding the results of the query.
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides

ExecuteReaderAsync(SoCommand, CancellationToken)

Overridden because we cannot use the max limit in the superclass here. We always need to get every usergroup/webpanel link.

Declaration
protected override Task<SoDataReader> ExecuteReaderAsync(SoCommand cmd, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SoCommand cmd
CancellationToken cancellationToken
Returns
Type Description
Task<SoDataReader>
Overrides

GetMainQueryAsync(CancellationToken)

Get the main query for the list.

Declaration
protected override Task<Select> GetMainQueryAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Select>
Overrides

InitAsync(CancellationToken)

Initiate the provider after the ConstructAsync(string, string, int[], bool, string, bool, CancellationToken) method is called.

Declaration
protected override Task InitAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides

OnRead(SoDataReader, short)

Raised every time a new row has been read from the database.
The implementation should read tthe results from the reader and populate an object implementing ISoListItem.

Declaration
protected override ISoListItem OnRead(SoDataReader reader, short lastRank)
Parameters
Type Name Description
SoDataReader reader

Reader to reaf from.
short lastRank

Value of the last rank populated.
Returns
Type Description
ISoListItem

Data read from the reader.
Overrides

SetSearchRestrictionAsync(Select, string)

Set the search restriction on the list.

Declaration
protected override Task SetSearchRestrictionAsync(Select sql, string searchValue)
Parameters
Type Name Description
Select sql

Query to set the search restriction on.
string searchValue

The value of the search restriction.
Returns
Type Description
Task
Overrides

Implements

Extension Methods