Class ListItemsProvider
Archive provider for the list of ListItems
Implements
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
[ArchiveProvider("ListItems", 1073741823)]
public class ListItemsProvider : QueryProviderBase<ArchiveRow>, IArchiveProviderQueryMapping, IArchiveQueryProvider, IArchiveProviderExtensible, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntitiesRemarks
Blah...
blah.... ... ........Constructors
ListItemsProvider()
Archive provider for the list of ListItems
Declaration
protected ListItemsProvider()Remarks
Blah...
blah.... ... ........Fields
ProviderName
Archive provider for the list of ListItems
Declaration
public const string ProviderName = "ListItems"Field Value
| Type | Description |
|---|---|
| string |
Remarks
Blah...
blah.... ... ........_colDeleted
Archive provider for the list of ListItems
Declaration
protected ArchiveColumnInfo _colDeletedField Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
Remarks
Blah...
blah.... ... ........_colEmailTemplateType
Archive provider for the list of ListItems
Declaration
protected ArchiveColumnInfo _colEmailTemplateTypeField Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
Remarks
Blah...
blah.... ... ........_colId
Archive provider for the list of ListItems
Declaration
protected ArchiveColumnInfo _colIdField Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
Remarks
Blah...
blah.... ... ........_colLocation
Archive provider for the list of ListItems
Declaration
protected ArchiveColumnInfo _colLocationField Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
Remarks
Blah...
blah.... ... ........_colName
Archive provider for the list of ListItems
Declaration
protected ArchiveColumnInfo _colNameField Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
Remarks
Blah...
blah.... ... ........_colProbability
Archive provider for the list of ListItems
Declaration
protected ArchiveColumnInfo _colProbabilityField Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
Remarks
Blah...
blah.... ... ........_colRank
Archive provider for the list of ListItems
Declaration
protected ArchiveColumnInfo _colRankField Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
Remarks
Blah...
blah.... ... ........_colRecordType
Archive provider for the list of ListItems
Declaration
protected ArchiveColumnInfo _colRecordTypeField Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
Remarks
Blah...
blah.... ... ........_colTooltip
Archive provider for the list of ListItems
Declaration
protected ArchiveColumnInfo _colTooltipField Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
Remarks
Blah...
blah.... ... ........_colUDListDefintionId
Archive provider for the list of ListItems
Declaration
protected ArchiveColumnInfo _colUDListDefintionIdField Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
Remarks
Blah...
blah.... ... ........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
Remarks
Blah...
blah.... ... ........Query
The main query of this archive provider, from the derived class
Declaration
public override ArchiveSelect Query { get; }Property Value
| Type | Description |
|---|---|
| ArchiveSelect |
Overrides
Remarks
Blah...
blah.... ... ........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
Remarks
Blah...
blah.... ... ........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
Remarks
Blah...
blah.... ... ........InnerMapFields()
Add/map return fields to the query; call SetJoin to obtain the contact table info instance from the derived class
Declaration
public override void InnerMapFields()Overrides
Remarks
Blah...
blah.... ... ........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
Remarks
Blah...
blah.... ... ........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
Remarks
Blah...
blah.... ... ........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
Remarks
Blah...
blah.... ... ........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
Remarks
Blah...
blah.... ... ........