Class OwnerContactProvider

MDO provider for listing owner contacts.

Inheritance
object
AnyTableListProviderBase
OwnerContactProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("OwnerContact")]
[MDOAdditionalInfo("addallitem", "Add an extra item for ALL Companies to list", "y")]
public class OwnerContactProvider : AnyTableListProviderBase, ISoListProvider, ISoList

Constructors

OwnerContactProvider()

Constructor

Declaration
public OwnerContactProvider()

Fields

ProviderName

MDO provider for listing owner contacts.

Declaration
public const string ProviderName = "OwnerContact"
Field Value
Type Description
string

_contactTableInfo

MDO provider for listing owner contacts.

Declaration
protected ContactTableInfo _contactTableInfo
Field Value
Type Description
ContactTableInfo

_ownerContactLinkTableInfo

MDO provider for listing owner contacts.

Declaration
protected OwnerContactLinkTableInfo _ownerContactLinkTableInfo
Field Value
Type Description
OwnerContactLinkTableInfo

Properties

TableInfo

The main table info for the query.

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

Methods

GetMainQueryAsync(CancellationToken)

Obtain the main query for OwnerContactLink

Declaration
protected override Task<Select> GetMainQueryAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Select>

Query for the Owner contacts
Overrides

InitAsync(CancellationToken)

Initiate the provider after the Construct method is called.

Declaration
protected override Task InitAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides

OnPostGetRootItemsAsync(List<ISoListItem>)

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

Declaration
protected override Task OnPostGetRootItemsAsync(List<ISoListItem> items)
Parameters
Type Name Description
List<ISoListItem> items

List of items returned from GetRootItemsAsync(CancellationToken).
Returns
Type Description
Task
Overrides

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

SetSearchRestrictionAsync(Select, string)

Set the search restriction on the list.

Declaration
protected override Task SetSearchRestrictionAsync(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.
Returns
Type Description
Task
Overrides

Implements

Extension Methods