Class DashboardProvider

MDO list provider for Dashboard, can be used by Navigator.

Inheritance
object
AnyTableListProviderBase
DashboardProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("Dashboard")]
[MDOAdditionalInfoSeparator("&")]
[MDOAdditionalInfo("OnlyMine", "Return only the current users dashboards", false)]
[MDOAdditionalInfo("CanUpdate", "Only return dashboards you are allowed to update", false)]
[MDOAdditionalInfo("ExcludeIds", "Comma separated list of IDs to be omitted from the result", false)]
public class DashboardProvider : AnyTableListProviderBase, ISoListProvider, ISoList

Constructors

DashboardProvider()

Constructor

Declaration
public DashboardProvider()

Fields

ProviderName

MDO list provider for Dashboard, can be used by Navigator.

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

Properties

HistoryInfo

MDO list provider for Dashboard, can be used by Navigator.

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

TableInfo

The main table info for the query.

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

Methods

GetHistoryItemsFromDbAsync(CancellationToken)

Get all the history items from the database

Declaration
protected override Task<List<ISoListItem>> GetHistoryItemsFromDbAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<List<ISoListItem>>

Root items.
Overrides

GetMainQueryAsync(CancellationToken)

Obtain the main query

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

Query
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