Class SatellitesProvider

SatelliteProvider creates a MDO list of satellites.

Inheritance
object
AnyTableListProviderBase
SatellitesProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("Satellites")]
[MDOAdditionalInfo("addcentral", "add a the central satellite to list", "1")]
public class SatellitesProvider : AnyTableListProviderBase, ISoListProvider, ISoList

Constructors

SatellitesProvider()

SatelliteProvider creates a MDO list of satellites.

Declaration
public SatellitesProvider()

Fields

ProviderName

The name of the provider.

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

Properties

TableInfo

The 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

Methods

GetMainQueryAsync(CancellationToken)

Get the query to retrieve satellites in the database.

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

InitAsync(CancellationToken)

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

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

OnPreGetRootItemsAsync(List<ISoListItem>)

Event raised by GetRootItemsAsync(CancellationToken) before values are fetched from the database. Adding option for empty role at the beginning of list

Declaration
protected override Task OnPreGetRootItemsAsync(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 the 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 read 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