Class ListItemsProvider

Archive provider for the list of ListItems

Inheritance
object
ExtensibleColumnsBase
QueryProviderBase<ArchiveRow>
ListItemsProvider
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[ArchiveProvider("ListItems", 1073741823)]
public class ListItemsProvider : QueryProviderBase<ArchiveRow>, IArchiveProviderQueryMapping, IArchiveQueryProvider, IArchiveProviderExtensible, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities

Constructors

ListItemsProvider()

Archive provider for the list of ListItems

Declaration
protected ListItemsProvider()

Fields

ProviderName

Archive provider for the list of ListItems

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

_colDeleted

Archive provider for the list of ListItems

Declaration
protected ArchiveColumnInfo _colDeleted
Field Value
Type Description
ArchiveColumnInfo

_colEmailTemplateType

Archive provider for the list of ListItems

Declaration
protected ArchiveColumnInfo _colEmailTemplateType
Field Value
Type Description
ArchiveColumnInfo

_colId

Archive provider for the list of ListItems

Declaration
protected ArchiveColumnInfo _colId
Field Value
Type Description
ArchiveColumnInfo

_colLocation

Archive provider for the list of ListItems

Declaration
protected ArchiveColumnInfo _colLocation
Field Value
Type Description
ArchiveColumnInfo

_colName

Archive provider for the list of ListItems

Declaration
protected ArchiveColumnInfo _colName
Field Value
Type Description
ArchiveColumnInfo

_colProbability

Archive provider for the list of ListItems

Declaration
protected ArchiveColumnInfo _colProbability
Field Value
Type Description
ArchiveColumnInfo

_colRank

Archive provider for the list of ListItems

Declaration
protected ArchiveColumnInfo _colRank
Field Value
Type Description
ArchiveColumnInfo

_colRecordType

Archive provider for the list of ListItems

Declaration
protected ArchiveColumnInfo _colRecordType
Field Value
Type Description
ArchiveColumnInfo

_colTooltip

Archive provider for the list of ListItems

Declaration
protected ArchiveColumnInfo _colTooltip
Field Value
Type Description
ArchiveColumnInfo

_colUDListDefintionId

Archive provider for the list of ListItems

Declaration
protected ArchiveColumnInfo _colUDListDefintionId
Field Value
Type Description
ArchiveColumnInfo

Properties

PrimaryTable

The primary table of this archive provider, from the derived class

Declaration
public override TableInfo PrimaryTable { get; }
Property Value
Type Description
TableInfo
Overrides

Query

The main query of this archive provider, from the derived class

Declaration
public override ArchiveSelect Query { get; }
Property Value
Type Description
ArchiveSelect
Overrides

RootExtenders

Implement this property to return the extender(s) that form the root of the query tree, or null if that is not meaningful. This property is used by the dynamic column processing, which will fail and throw an exception if null is returned here (no problem if dynamic column syntax is not used)

Declaration
protected override List<IArchiveExtender> RootExtenders { get; }
Property Value
Type Description
List<IArchiveExtender>
Overrides

Methods

AcceptRow(SoDataReader)

Accept only those rows that have at least one of the desired rowtypes

Declaration
protected override bool AcceptRow(SoDataReader reader)
Parameters
Type Name Description
SoDataReader reader
Returns
Type Description
bool
Overrides

InnerMapFieldsAsync(CancellationToken)

Add/map return fields to the query; call SetJoin to obtain the contact table info instance from the derived class

Declaration
public override Task InnerMapFieldsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides

InnerPopulateRowFromReader(SoDataReader, ArchiveRow)

Derived classes should implement the population of ColumnData items for columns that are NOT handled by this base class in this method. Whether a column is handled by this base class is part of its database binding information, set by the various MapXXX methods.

Declaration
protected override void InnerPopulateRowFromReader(SoDataReader reader, ArchiveRow row)
Parameters
Type Name Description
SoDataReader reader

Data reader with the query result (one row)
ArchiveRow row

archive row to be populated
Overrides

RequiredPhaseOneFields()

Return the FieldInfo fields needed by AcceptRow(SoDataReader), so that the query rewriter does not drop them. Implement this method IFF you implement AcceptRow.

Declaration
protected override FieldInfo[] RequiredPhaseOneFields()
Returns
Type Description
FieldInfo[]
Overrides

SetDesiredEntities(params string[])

Set the desired entities

Declaration
public override void SetDesiredEntities(params string[] entities)
Parameters
Type Name Description
string[] entities

Names of desired entities
Overrides

SetRestriction(params ArchiveRestrictionInfo[])

Set the restriction for the query. This method sets the restrictions for this provider, as well as invoking the same call on all known extenders. Recursion will take it to the bottom. This method actually only saves the restriction specification for use during query processing.

Declaration
public override bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)
Parameters
Type Name Description
ArchiveRestrictionInfo[] restrictions

Array of restrictions (implicit AND)
Returns
Type Description
bool
Overrides

Implements

Extension Methods