Class QuoteListsByIdProvider

Dynamic provider that dispatches Quote Connector lists, based on QuoteAlternativeId or SaleId and "Erp"+<list name>. Consider using "QM_"+<sale_id>+<list name> instead if you can.

Inheritance
object
QuoteListsByIdProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[DynamicMDOProviderPlugin("QuoteListsById", 1073741823)]
[MDOAdditionalInfoSeparator("&")]
[MDOAdditionalInfo("QuoteAlternativeId", "Quote alternative implies sale id, which tells us which quote connection to get", 1234)]
[MDOAdditionalInfo("SaleId", "Sale to get quotes from which tells us which quote connection to get", 1234)]
public sealed class QuoteListsByIdProvider : IDynamicMDOProvider, ISoListProvider, ISoList
Remarks

See the remarks on QuoteListsByNameProvider for an overview of Quote List dispatching, which is fairly complex.

Constructors

QuoteListsByIdProvider()

Dynamic provider that dispatches Quote Connector lists, based on QuoteAlternativeId or SaleId and "Erp"+<list name>. Consider using "QM_"+<sale_id>+<list name> instead if you can.

Declaration
public QuoteListsByIdProvider()
Remarks

See the remarks on QuoteListsByNameProvider for an overview of Quote List dispatching, which is fairly complex.

Fields

ListNamePrefix

Dynamic provider that dispatches Quote Connector lists, based on QuoteAlternativeId or SaleId and "Erp"+<list name>. Consider using "QM_"+<sale_id>+<list name> instead if you can.

Declaration
public const string ListNamePrefix = "Erp"
Field Value
Type Description
string
Remarks

See the remarks on QuoteListsByNameProvider for an overview of Quote List dispatching, which is fairly complex.

Properties

HistoryInfo

History information for the supported list

Declaration
public HistoryInfo HistoryInfo { get; }
Property Value
Type Description
HistoryInfo
Remarks

See the remarks on QuoteListsByNameProvider for an overview of Quote List dispatching, which is fairly complex.

SupportedLists

Return information about all supported lists

Declaration
public HistoryInfo[] SupportedLists { get; }
Property Value
Type Description
HistoryInfo[]
Remarks

See the remarks on QuoteListsByNameProvider for an overview of Quote List dispatching, which is fairly complex.

Methods

ClearHistoryItems()

Clears the history items

Declaration
public void ClearHistoryItems()
Remarks

See the remarks on QuoteListsByNameProvider for an overview of Quote List dispatching, which is fairly complex.

ConstructAsync(string, string, int[], bool, string, bool, CancellationToken)

Phase two of two-stage list construction. To be called right after the constructor, at which point all constructors have run, and the class hierarchy is initialized.

Declaration
public Task ConstructAsync(string listName, string additionalInfo, int[] historyIDs, bool onlyReadHistory, string searchValue, bool forceFlatList, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string listName

List name (though note that as implemented by MDOProviderBase, this actually has to be a real table name, so subclasses should override and convert from their list name to a real table name) (yes it's a bit messy)
string additionalInfo

Additional information to provider
int[] historyIDs

Array of history ID's; if non-null, this will BE the history; a non-null but empty array will disable reading of history altogether; a null parameter will cause history to be read from the database.
bool onlyReadHistory

if true, only history will be read.
string searchValue

If non-null, the returned list will be flat and only consist of search matches
bool forceFlatList

If true, the returned list will be flat, though it will still be filtered if grouping/filtering has been set up for the list
CancellationToken cancellationToken
Returns
Type Description
Task
Remarks

See the remarks on QuoteListsByNameProvider for an overview of Quote List dispatching, which is fairly complex.

GetHeadingItemsAsync(CancellationToken)

list of headings

Declaration
public Task<List<ISoListHeading>> GetHeadingItemsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<List<ISoListHeading>>
Remarks

See the remarks on QuoteListsByNameProvider for an overview of Quote List dispatching, which is fairly complex.

GetHistoryItemsAsync(CancellationToken)

list of history items

Declaration
public Task<List<ISoListItem>> GetHistoryItemsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<List<ISoListItem>>
Remarks

See the remarks on QuoteListsByNameProvider for an overview of Quote List dispatching, which is fairly complex.

GetRootItemsAsync(CancellationToken)

list of root-level items (items not under any heading)

Declaration
public Task<List<ISoListItem>> GetRootItemsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<List<ISoListItem>>
Remarks

See the remarks on QuoteListsByNameProvider for an overview of Quote List dispatching, which is fairly complex.

Implements

Extension Methods