Class FreetextCountProvider

Archive provider for counts of freetext matches

Inheritance
Object
InMemoryProviderBase<ArchiveFreetextCountRow>
FreetextCountProvider
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
[ArchiveProvider("FreetextCount", 1073741823)]
public class FreetextCountProvider : InMemoryProviderBase<ArchiveFreetextCountRow>, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities, IPlugin
Remarks

The purpose if this provider is to provide simple counts of matches, grouped by owning entity. In the GUI, this corresponds to the tabs in the freetext search result dialog, and the numbers on those tabs. To get actual matches for a particular entity, use the corresponding FreetextSearchProvider, for instance, the FreetextContactResultProvider.

The 'OwnerEntityName' column accepts a restriction in the form of an array of strings or table names. If provided, this restriction will limit the entities searched. The FreetextSearchEntityProvider is an MDO provider for supported entities.

Constructors

FreetextCountProvider()

Set up the provider and entity

Declaration
public FreetextCountProvider()

Fields

_colCount

Declaration
protected ArchiveColumnInfo _colCount
Field Value
Type Description
ArchiveColumnInfo

_colEntityLocalizedName

Declaration
protected ArchiveColumnInfo _colEntityLocalizedName
Field Value
Type Description
ArchiveColumnInfo

_colEntityName

Declaration
protected ArchiveColumnInfo _colEntityName
Field Value
Type Description
ArchiveColumnInfo

_colWords

Declaration
protected ArchiveColumnInfo _colWords
Field Value
Type Description
ArchiveColumnInfo

EntityName

Declaration
public const string EntityName = "freetextcount"
Field Value
Type Description
String

ProviderName

Declaration
public const string ProviderName = "FreetextCount"
Field Value
Type Description
String

Properties

BaseClassShouldFilterColumns

Declaration
protected override bool BaseClassShouldFilterColumns { get; }
Property Value
Type Description
Boolean
Overrides
SuperOffice.CRM.ArchiveLists.InMemoryProviderBase<SuperOffice.CRM.ArchiveLists.ArchiveFreetextCountRow>.BaseClassShouldFilterColumns

BaseClassShouldFilterEntities

Declaration
protected override bool BaseClassShouldFilterEntities { get; }
Property Value
Type Description
Boolean
Overrides
SuperOffice.CRM.ArchiveLists.InMemoryProviderBase<SuperOffice.CRM.ArchiveLists.ArchiveFreetextCountRow>.BaseClassShouldFilterEntities

BaseClassShouldPage

Declaration
protected override bool BaseClassShouldPage { get; }
Property Value
Type Description
Boolean
Overrides
SuperOffice.CRM.ArchiveLists.InMemoryProviderBase<SuperOffice.CRM.ArchiveLists.ArchiveFreetextCountRow>.BaseClassShouldPage

BaseClassShouldSort

Declaration
protected override bool BaseClassShouldSort { get; }
Property Value
Type Description
Boolean
Overrides
SuperOffice.CRM.ArchiveLists.InMemoryProviderBase<SuperOffice.CRM.ArchiveLists.ArchiveFreetextCountRow>.BaseClassShouldSort

Methods

GetResultData()

Call on the FreetextMatchCalculator to do a search, and consolidate the results into counts. Create a set of archive rows to return to the base class containing those results.

Declaration
protected override List<ArchiveFreetextCountRow> GetResultData()
Returns
Type Description
List<ArchiveFreetextCountRow>
Overrides
SuperOffice.CRM.ArchiveLists.InMemoryProviderBase<SuperOffice.CRM.ArchiveLists.ArchiveFreetextCountRow>.GetResultData()

SetRestriction(ArchiveRestrictionInfo[])

Extract freetext search word restrictions. The operator of the restriction is always taken to be in/begins, regardless of what is actually specified

Declaration
public override bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)
Parameters
Type Name Description
ArchiveRestrictionInfo[] restrictions
Returns
Type Description
Boolean
Overrides
SuperOffice.CRM.ArchiveLists.InMemoryProviderBase<SuperOffice.CRM.ArchiveLists.ArchiveFreetextCountRow>.SetRestriction(SuperOffice.CRM.ArchiveLists.ArchiveRestrictionInfo[])

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)