Class TypedMultiQueryProviderBase<RowType>
Base class for multi-channel providers that have a strongly typed archive row type. It will get and set the standard columns from the row type, and cast generic result rows into strongly typed ones.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
public abstract class TypedMultiQueryProviderBase<RowType> : MultiQueryProviderBase, IArchiveMultiQueryProvider, IArchiveTypedProvider<RowType>, IArchiveTypedProviderBase, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities where RowType : ArchiveRow, new()Type Parameters
| Name | Description |
|---|---|
| RowType |
Constructors
TypedMultiQueryProviderBase()
Create a new, empty provider
Declaration
protected TypedMultiQueryProviderBase()TypedMultiQueryProviderBase(params string[])
Create a new provider, and instantiate the given providers by name (through the factory) and add them to this multichannel provider. Note that all such subproviders have to have archive row types descended from the RowType type parameter to this class
Declaration
protected TypedMultiQueryProviderBase(params string[] providerNames)Parameters
| Type | Name | Description |
|---|---|---|
| string[] | providerNames | Zero or more names of providers to instantiate through the factory |
Methods
GetRowsAsync(string, CancellationToken)
Get the rows, as strongly typed elements
Declaration
public IAsyncEnumerable<RowType> GetRowsAsync(string options, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | options | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| IAsyncEnumerable<RowType> |
GetRowsAsync(CancellationToken)
Get the rows, as strongly typed elements
Declaration
public IAsyncEnumerable<RowType> GetRowsAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| IAsyncEnumerable<RowType> |
GetStandardColumnNames()
Get the standard column names from the Archive row type
Declaration
public string[] GetStandardColumnNames()Returns
| Type | Description |
|---|---|
| string[] |
SetAdditionalColumns(params string[])
Set additional return columns (the standard columns are always included)
Declaration
public void SetAdditionalColumns(params string[] additionalColumns)Parameters
| Type | Name | Description |
|---|---|---|
| string[] | additionalColumns |