Class DocumentListProvider

MDO list provider for documents.

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

Constructors

DocumentListProvider()

Constructor

Declaration
public DocumentListProvider()

Fields

ProviderName

MDO list provider for documents.

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

_documentTableInfo

MDO list provider for documents.

Declaration
protected DocumentTableInfo _documentTableInfo
Field Value
Type Description
DocumentTableInfo

Properties

HistoryInfo

MDO list provider for documents.

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

GetMainQueryAsync(CancellationToken)

Obtain the main query for the Document

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

Query for the Document
Overrides

InitAsync(CancellationToken)

Initiate the provider after the Construct 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