Class LegalBaseListProvider
MDO list provider for Legal base
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("legalbase")]
public class LegalBaseListProvider : AnyTableListProviderBase, ISoListProvider, ISoList
Constructors
LegalBaseListProvider()
Constructor
Declaration
public LegalBaseListProvider()
Fields
ProviderName
MDO list provider for Legal base
Declaration
public const string ProviderName = "legalbase"
Field Value
Type | Description |
---|---|
string |
Properties
HistoryInfo
MDO list provider for Legal base
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
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
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 |