Class ChartSelectionProvider
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("ChartSelection")]
[MDOAdditionalInfoSeparator("&")]
[MDOAdditionalInfo("SelectionProvider", "Return chart selections associated with the given selection provider", "")]
[MDOAdditionalInfo("tableName", "Return chart selections associated with the given table", "")]
[MDOAdditionalInfo("providerName", "Return chart selections associated with the given table", "")]
public class ChartSelectionProvider : AnyTableListProviderBase, ISoListProvider, ISoList
Constructors
ChartSelectionProvider()
Declaration
public ChartSelectionProvider()
Fields
ProviderName
Declaration
public const string ProviderName = "ChartSelection"
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
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 |