Show / Hide Table of Contents

Class EmailAddressProvider

List of e-mail addresses matching the search value Searches e-mail address, person name, company name.

E-mail address matches: return e-mail addresses + owner name (person or contact name)

Person name matches: return all e-mail addresses for matched persons

Company name matches. return all persons + first e-mail address for matched persons.

Inheritance
Object
AnyTableListProviderBase
EmailAddressProvider
Implements
ISoListProvider
ISoList
Inherited Members
AnyTableListProviderBase.Construct(String, String, Int32[], Boolean, String, Boolean)
AnyTableListProviderBase.GetHistoryItems()
AnyTableListProviderBase.GetRootItems()
AnyTableListProviderBase.OnPreGetRootItems(List<ISoListItem>)
AnyTableListProviderBase.SetHistoryRestriction(Select)
AnyTableListProviderBase.ExecuteQuery(Select, List<ISoListItem>)
AnyTableListProviderBase.ExecuteReader(SoCommand)
AnyTableListProviderBase.ListName
AnyTableListProviderBase.AdditionalInfo
AnyTableListProviderBase.HistoryIDs
AnyTableListProviderBase.OnlyReadHistory
AnyTableListProviderBase.SearchValue
AnyTableListProviderBase.ForceFlatList
AnyTableListProviderBase.HistoryInfo
AnyTableListProviderBase.HistoryItems
AnyTableListProviderBase.RootItems
AnyTableListProviderBase.HeadingItems
Object.ToString()
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("emailaddress")]
public class EmailAddressProvider : AnyTableListProviderBase, ISoListProvider, ISoList, IPlugin
Remarks

Returns: list item with

id = e-mail address id

Name = name + e-mail

ExtraInfo = e-mail address

Type = "Person" or "Contact"

Constructors

EmailAddressProvider()

Constructor

Declaration
public EmailAddressProvider()

Fields

_contactTable

Declaration
protected ContactTableInfo _contactTable
Field Value
Type Description
ContactTableInfo

_emailTable

Declaration
protected EmailTableInfo _emailTable
Field Value
Type Description
EmailTableInfo

_personTable

Declaration
protected PersonTableInfo _personTable
Field Value
Type Description
PersonTableInfo

_searchTerms

Declaration
protected string[] _searchTerms
Field Value
Type Description
String[]

_searchValue

Declaration
protected string _searchValue
Field Value
Type Description
String

ProviderName

"emailaddress"

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

Properties

TableInfo

The main table info for the query.

Declaration
protected override TableInfo TableInfo { get; }
Property Value
Type Description
TableInfo
Overrides
AnyTableListProviderBase.TableInfo

Methods

GetContactEmailQuery()

Declaration
protected Select GetContactEmailQuery()
Returns
Type Description
Select

GetMainQuery()

Obtain the main query for the e-mail addresses on persons

Declaration
protected override Select GetMainQuery()
Returns
Type Description
Select

Query for the e-mail and persons (and contacts if _contactTable defined)

Overrides
AnyTableListProviderBase.GetMainQuery()

Init()

Declaration
protected override void Init()
Overrides
AnyTableListProviderBase.Init()

OnPostGetRootItems(List<ISoListItem>)

Sort the matches into rank order, so that the best matches are listed first, if there are search terms. If no search terms, then we do not modify the list.

Declaration
protected override void OnPostGetRootItems(List<ISoListItem> items)
Parameters
Type Name Description
List<ISoListItem> items

Results - will be re-ordered if there are search terms

Overrides
AnyTableListProviderBase.OnPostGetRootItems(List<ISoListItem>)

OnRead(SoDataReader, Int16)

Declaration
protected override ISoListItem OnRead(SoDataReader reader, short lastRank)
Parameters
Type Name Description
SoDataReader reader
Int16 lastRank
Returns
Type Description
ISoListItem
Overrides
AnyTableListProviderBase.OnRead(SoDataReader, Int16)

SetContactSearchRestriction(Select)

Search contact + e-mail addresses for matches to the _searchValue

Declaration
protected void SetContactSearchRestriction(Select sql)
Parameters
Type Name Description
Select sql

Query to set the search restriction on.

SetSearchRestriction(Select, String)

First search person first + last names + e-mail addresses for matches Set the search restriction on the list.

Declaration
protected override void SetSearchRestriction(Select sql, string searchValue)
Parameters
Type Name Description
Select sql

Query to set the search restriction on.

String searchValue

The value of the search restriction.

Overrides
AnyTableListProviderBase.SetSearchRestriction(Select, String)

SortItemsByScore(List<ISoListItem>)

Declaration
protected void SortItemsByScore(List<ISoListItem> items)
Parameters
Type Name Description
List<ISoListItem> items

Implements

ISoListProvider
ISoList

Extension Methods

EnumUtil.MapEnums<From, To>(From)
ObjectExtensions.AssignByReflection<T>(T, T)
ObjectExtensions.GraphCopy<T>(T)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top