Class FreetextCountProvider
Archive provider for counts of freetext matches
Implements
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[ArchiveProvider("FreetextCount", 1073741823)]
public class FreetextCountProvider : InMemoryProviderBase<ArchiveFreetextCountRow>, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntitiesRemarks
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
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._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.Properties
BaseClassShouldFilterColumns
Subclass contract: Return true if the base class should filter columns according to SetDesiredColumns. If this property is false, the actual ArchiveRow objects are returned; otherwise a typed copy is made and ColumnData are populated accoprding to DesiredColumns.
Declaration
protected override bool BaseClassShouldFilterColumns { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
Remarks
If columns are cheap to get, the subclass can save code by leaving the filtering to this base class. Conversely, if somecolumns are expensive to calculate, the subclass should do the filtering itself to improve performance.
BaseClassShouldFilterEntities
Subclass contract: Return true if the base class should filter columns according to SetDesiredColumns. If this property is false, the actual ArchiveRow objects are returned; otherwise a typed copy is made and ColumnData are populated accoprding to DesiredColumns.
Declaration
protected override bool BaseClassShouldFilterEntities { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
Remarks
If columns are cheap to get, the subclass can save code by leaving the filtering to this base class. Conversely, if somecolumns are expensive to calculate, the subclass should do the filtering itself to improve performance.
BaseClassShouldPage
Subclass contract: Return true if the base class should perform filter entities according to SetDesiredEntities. If this property is false, the result set is assumed to represent the chosen entities only.
Declaration
protected override bool BaseClassShouldPage { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
Remarks
If rows are cheap to get, the subclass can save code by leaving the filtering to this base class. Conversely, if rows are expensive to calculate, the subclass should do the entity filtering itself to improve performance.
BaseClassShouldSort
Subclass contract: Return true if the base class should perform sorting according to SetOrderBy. If this property is false, the result set is assumed to be correctly ordered.
Declaration
protected override bool BaseClassShouldSort { get; }Property Value
| Type | Description |
|---|---|
| bool |
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
GetResultDataAsync(CancellationToken)
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 IAsyncEnumerable<ArchiveFreetextCountRow> GetResultDataAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| IAsyncEnumerable<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(params 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 |
|---|---|
| bool |
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.