Class FreetextCountProvider
Archive provider for counts of freetext matches
Implements
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
[ArchiveProvider("FreetextCount", 1073741823)]
public class FreetextCountProvider : InMemoryProviderBase<ArchiveFreetextCountRow>, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities, IPluginRemarks
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()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.Fields
_colCount
Archive provider for counts of freetext matches
Declaration
protected ArchiveColumnInfo _colCountField Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
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._colEntityLocalizedName
Archive provider for counts of freetext matches
Declaration
protected ArchiveColumnInfo _colEntityLocalizedNameField Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
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._colEntityName
Archive provider for counts of freetext matches
Declaration
protected ArchiveColumnInfo _colEntityNameField Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
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._colWords
Archive provider for counts of freetext matches
Declaration
protected ArchiveColumnInfo _colWordsField Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
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.EntityName
Archive provider for counts of freetext matches
Declaration
public const string EntityName = "freetextcount"Field Value
| Type | Description |
|---|---|
| String |
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.ProviderName
Archive provider for counts of freetext matches
Declaration
public const string ProviderName = "FreetextCount"Field Value
| Type | Description |
|---|---|
| String |
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.Properties
BaseClassShouldFilterColumns
Archive provider for counts of freetext matches
Declaration
protected override bool BaseClassShouldFilterColumns { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Overrides
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.BaseClassShouldFilterEntities
Archive provider for counts of freetext matches
Declaration
protected override bool BaseClassShouldFilterEntities { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Overrides
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.BaseClassShouldPage
Archive provider for counts of freetext matches
Declaration
protected override bool BaseClassShouldPage { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Overrides
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.BaseClassShouldSort
Archive provider for counts of freetext matches
Declaration
protected override bool BaseClassShouldSort { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Overrides
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.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
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.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
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.