Class FreetextResultProviderBase<RootExtender, OwnerTableInfo>
Base class for all providers that return free text search results (not counts, but the actual contacts or whatever)
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
public abstract class FreetextResultProviderBase<RootExtender, OwnerTableInfo> : TypedQueryProviderBase<ArchiveRow, RootExtender>, IArchiveProviderQueryMapping, IArchiveQueryProvider, IArchiveProviderExtensible, IArchiveTypedProvider<ArchiveRow>, IArchiveTypedProviderBase, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities where RootExtender : IArchiveExtender, new() where OwnerTableInfo : TableInfo
Type Parameters
Name | Description |
---|---|
RootExtender | Data extender that will fetch the actual results |
OwnerTableInfo | Owner table/entity in the freetext system |
Remarks
This class handles all the functionality, and is simply parameterized with the extender that is to fetch data, and the (single!) tableinfo that represents the owner entity we are searching on behalf of. A maximum of 1000 rows is fetched, subject to the usual Sentry filtering.
Use the 'searchwords' restriction with one or more words to specify what to search for. The operator is ignored, the freetext search will apply the 'begins' operator to each word and 'AND' between them.Constructors
FreetextResultProviderBase()
Base class for all providers that return free text search results (not counts, but the actual contacts or whatever)
Declaration
public FreetextResultProviderBase()
Remarks
This class handles all the functionality, and is simply parameterized with the extender that is to fetch data, and the (single!) tableinfo that represents the owner entity we are searching on behalf of. A maximum of 1000 rows is fetched, subject to the usual Sentry filtering.
Use the 'searchwords' restriction with one or more words to specify what to search for. The operator is ignored, the freetext search will apply the 'begins' operator to each word and 'AND' between them.Fields
_colWords
Base class for all providers that return free text search results (not counts, but the actual contacts or whatever)
Declaration
protected ArchiveColumnInfo _colWords
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
Remarks
This class handles all the functionality, and is simply parameterized with the extender that is to fetch data, and the (single!) tableinfo that represents the owner entity we are searching on behalf of. A maximum of 1000 rows is fetched, subject to the usual Sentry filtering.
Use the 'searchwords' restriction with one or more words to specify what to search for. The operator is ignored, the freetext search will apply the 'begins' operator to each word and 'AND' between them.Methods
GetAvailableEntities()
Get all entities declared by this provider and its extenders
Declaration
public override List<ArchiveRowTypeInfo> GetAvailableEntities()
Returns
Type | Description |
---|---|
List<ArchiveRowTypeInfo> | List of available entities |
Overrides
Remarks
This class handles all the functionality, and is simply parameterized with the extender that is to fetch data, and the (single!) tableinfo that represents the owner entity we are searching on behalf of. A maximum of 1000 rows is fetched, subject to the usual Sentry filtering.
Use the 'searchwords' restriction with one or more words to specify what to search for. The operator is ignored, the freetext search will apply the 'begins' operator to each word and 'AND' between them.InnerPopulateRowFromReader(SoDataReader, ArchiveRow)
Override: Add link hint, corresponding to row entity
Declaration
protected override void InnerPopulateRowFromReader(SoDataReader reader, ArchiveRow row)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | |
ArchiveRow | row |
Overrides
Remarks
This class handles all the functionality, and is simply parameterized with the extender that is to fetch data, and the (single!) tableinfo that represents the owner entity we are searching on behalf of. A maximum of 1000 rows is fetched, subject to the usual Sentry filtering.
Use the 'searchwords' restriction with one or more words to specify what to search for. The operator is ignored, the freetext search will apply the 'begins' operator to each word and 'AND' between them.PostProcessQuery()
This method is called after ModifyQuery has been called on all extenders, but before the query is executed. It is used for processing that needs the query to be 'complete' from the extenders, and gives the opportunity to tweak it, for instance by adding return fields needed for some particular functionality.
Declaration
public override void PostProcessQuery()
Overrides
Remarks
This class handles all the functionality, and is simply parameterized with the extender that is to fetch data, and the (single!) tableinfo that represents the owner entity we are searching on behalf of. A maximum of 1000 rows is fetched, subject to the usual Sentry filtering.
Use the 'searchwords' restriction with one or more words to specify what to search for. The operator is ignored, the freetext search will apply the 'begins' operator to each word and 'AND' between them.SetRestriction(params ArchiveRestrictionInfo[])
Override: Extract search word reststrictions
Declaration
public override bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)
Parameters
Type | Name | Description |
---|---|---|
ArchiveRestrictionInfo[] | restrictions |
Returns
Type | Description |
---|---|
bool |
Overrides
Remarks
This class handles all the functionality, and is simply parameterized with the extender that is to fetch data, and the (single!) tableinfo that represents the owner entity we are searching on behalf of. A maximum of 1000 rows is fetched, subject to the usual Sentry filtering.
Use the 'searchwords' restriction with one or more words to specify what to search for. The operator is ignored, the freetext search will apply the 'begins' operator to each word and 'AND' between them.