Class QuoteDocuments

MDO provider for the list of current / candidate "main document" for a given quote

Inheritance
object
AnyTableListProviderBase
QuoteDocuments
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("QuoteDocuments")]
[MDOAdditionalInfo("QuoteId", "Quote to get documents for.", 123)]
public class QuoteDocuments : AnyTableListProviderBase, ISoListProvider, ISoList
Remarks

We need those document rows that point to documents connected to the same sale as the quote record, with document template of type MainDocument, and we'd like the id, header & long text please.

Pass in QuoteId=<id> to identify the quote you want documents for, in AdditionalInfo.

Constructors

QuoteDocuments()

MDO provider for the list of current / candidate "main document" for a given quote

Declaration
public QuoteDocuments()
Remarks

We need those document rows that point to documents connected to the same sale as the quote record, with document template of type MainDocument, and we'd like the id, header & long text please.

Pass in QuoteId=<id> to identify the quote you want documents for, in AdditionalInfo.

Fields

ProviderName

MDO provider for the list of current / candidate "main document" for a given quote

Declaration
public const string ProviderName = "QuoteDocuments"
Field Value
Type Description
string
Remarks

We need those document rows that point to documents connected to the same sale as the quote record, with document template of type MainDocument, and we'd like the id, header & long text please.

Pass in QuoteId=<id> to identify the quote you want documents for, in AdditionalInfo.

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
Remarks

We need those document rows that point to documents connected to the same sale as the quote record, with document template of type MainDocument, and we'd like the id, header & long text please.

Pass in QuoteId=<id> to identify the quote you want documents for, in AdditionalInfo.

Methods

GetMainQueryAsync(CancellationToken)

Override: Database query. We need those document rows that point to documents connected to the same sale as the quote record, with document template of type MainDocument, and we'd like the id, header & long text please.

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

We need those document rows that point to documents connected to the same sale as the quote record, with document template of type MainDocument, and we'd like the id, header & long text please.

Pass in QuoteId=<id> to identify the quote you want documents for, in AdditionalInfo.

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
Remarks

We need those document rows that point to documents connected to the same sale as the quote record, with document template of type MainDocument, and we'd like the id, header & long text please.

Pass in QuoteId=<id> to identify the quote you want documents for, in AdditionalInfo.

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
Remarks

We need those document rows that point to documents connected to the same sale as the quote record, with document template of type MainDocument, and we'd like the id, header & long text please.

Pass in QuoteId=<id> to identify the quote you want documents for, in AdditionalInfo.

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
Remarks

We need those document rows that point to documents connected to the same sale as the quote record, with document template of type MainDocument, and we'd like the id, header & long text please.

Pass in QuoteId=<id> to identify the quote you want documents for, in AdditionalInfo.

Implements

Extension Methods