Class EmailPhoneProvider

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

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

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

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

Inheritance

object

AnyTableListProviderBase

EmailPhoneProvider

Implements

ISoListProvider

ISoList

Inherited Members

AnyTableListProviderBase.Construct(string, string, int[], bool, string, bool)

AnyTableListProviderBase.OnPreGetRootItems(List<ISoListItem>)

AnyTableListProviderBase.SetHistoryRestriction(Select)

AnyTableListProviderBase.ExecuteReader(SoCommand)

AnyTableListProviderBase.ListName

AnyTableListProviderBase.AdditionalInfo

AnyTableListProviderBase.HistoryIDs

AnyTableListProviderBase.OnlyReadHistory

AnyTableListProviderBase.ExcludeHistory

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("emailphone")]
public class EmailPhoneProvider : AnyTableListProviderBase, ISoListProvider, ISoList

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

Constructors

EmailPhoneProvider()

Constructor

Declaration

public EmailPhoneProvider()

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

Fields

ProviderName

"emailphone"

Declaration

public const string ProviderName = "emailphone"

Field Value

Type	Description
string

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

_contactTable

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

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

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

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

Declaration

protected ContactTableInfo _contactTable

Field Value

Type	Description
ContactTableInfo

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

_emailTable

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

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

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

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

Declaration

protected EmailTableInfo _emailTable

Field Value

Type	Description
EmailTableInfo

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

_personTable

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

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

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

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

Declaration

protected PersonTableInfo _personTable

Field Value

Type	Description
PersonTableInfo

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

_phoneTable

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

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

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

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

Declaration

protected PhoneTableInfo _phoneTable

Field Value

Type	Description
PhoneTableInfo

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

_searchTerms

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

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

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

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

Declaration

protected string[] _searchTerms

Field Value

Type	Description
string[]

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

Properties

TableInfo

The main table info of the query. This is used by subclasses (e.g. this class) when restricting history data.

Declaration

protected override TableInfo TableInfo { get; }

Property Value

Type	Description
TableInfo

Overrides

AnyTableListProviderBase.TableInfo

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

Methods

ExecuteQuery(Select, List<ISoListItem>)

Execute the query in the database.

Declaration

protected override void ExecuteQuery(Select sql, List<ISoListItem> resultCollection)

Parameters

Type	Name	Description
Select	sql	The query to execute in the database.
List<ISoListItem>	resultCollection	Collection holding the results of the query.

Overrides

AnyTableListProviderBase.ExecuteQuery(Select, List<ISoListItem>)

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

GetContactPhoneQuery()

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

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

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

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

Declaration

protected Select GetContactPhoneQuery()

Returns

Type	Description
Select

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

GetHistoryItems()

Get all the history items from the database

Declaration

protected override List<ISoListItem> GetHistoryItems()

Returns

Type	Description
List<ISoListItem>	Root items.

Overrides

AnyTableListProviderBase.GetHistoryItems()

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

GetMainQuery()

Get the main query for the list.

Declaration

protected override Select GetMainQuery()

Returns

Type	Description
Select

Overrides

AnyTableListProviderBase.GetMainQuery()

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

GetRootItems()

Get all the root items from the database

Declaration

protected override List<ISoListItem> GetRootItems()

Returns

Type	Description
List<ISoListItem>	History items.

Overrides

AnyTableListProviderBase.GetRootItems()

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

Init()

Initiate the provider after the Construct(string, string, int[], bool, string, bool) method is called.

Declaration

protected override void Init()

Overrides

AnyTableListProviderBase.Init()

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

OnPostGetRootItems(List<ISoListItem>)

Event raised by GetRootItems() after values are fetched from the database.

Declaration

protected override void OnPostGetRootItems(List<ISoListItem> items)

Parameters

Type	Name	Description
List<ISoListItem>	items	List of items returned from GetRootItems().

Overrides

AnyTableListProviderBase.OnPostGetRootItems(List<ISoListItem>)

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

OnRead(SoDataReader, short)

Raised every time a new row has been read from the database.
The implementation should read tthe results from the reader and populate an object implementing ISoListItem.

Declaration

protected override ISoListItem OnRead(SoDataReader reader, short lastRank)

Parameters

Type	Name	Description
SoDataReader	reader	Reader to reaf from.
short	lastRank	Value of the last rank populated.

Returns

Type	Description
ISoListItem	Data read from the reader.

Overrides

AnyTableListProviderBase.OnRead(SoDataReader, short)

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

SetSearchRestriction(Select, string)

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)

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

SortItemsByScore(List<ISoListItem>)

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

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

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

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

Declaration

protected void SortItemsByScore(List<ISoListItem> items)

Parameters

Type	Name	Description
List<ISoListItem>	items

Remarks

Returns: list item with

Id = e-mail address/phone number id

Name = name + e-mail/phone

ExtraInfo = e-mail address/phone number

Type = "Email" or "Phone"

Implements

ISoListProvider

ISoList

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)

ObjectExtensions.AssignByReflection<T>(T, T)

ObjectExtensions.GraphCopy<T>(T)