Class EmailFlowListProvider
List provider for EmailFlow
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("EmailFlow")]
[MDOAdditionalInfoSeparator("&")]
[MDOAdditionalInfo("statuses", "Specified workflow statuses", "")]
public class EmailFlowListProvider : AnyTableListProviderBase, ISoListProvider, ISoList
Constructors
EmailFlowListProvider()
List provider for EmailFlow
Declaration
public EmailFlowListProvider()
Fields
ProviderName
List provider for EmailFlow
Declaration
public const string ProviderName = "EmailFlow"
Field Value
| Type | Description |
|---|---|
| string |
_hierarchy
List provider for EmailFlow
Declaration
protected bool _hierarchy
Field Value
| Type | Description |
|---|---|
| bool |
_statuses
List provider for EmailFlow
Declaration
protected List<WorkflowDefinitionStatus> _statuses
Field Value
| Type | Description |
|---|---|
| List<WorkflowDefinitionStatus> |
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
Methods
GetMainQueryAsync(CancellationToken)
Subclass contract: Get main query. We only fetch the neeeded fields, and use ascending sort by name, always
Declaration
protected override Task<Select> GetMainQueryAsync(CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<Select> | Query primed with return fields and orderby |
Overrides
InitAsync(CancellationToken)
Subclass contract: Initialize (nothing much here)
Declaration
protected override Task InitAsync(CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task |
Overrides
OnPostGetRootItemsAsync(List<ISoListItem>)
Event raised by GetRootItems after values are fetched from the database. Adding option for empty group at the beginning of list
Declaration
protected override Task OnPostGetRootItemsAsync(List<ISoListItem> items)
Parameters
| Type | Name | Description |
|---|---|---|
| List<ISoListItem> | items | List of items returned from GetRootItems. |
Returns
| Type | Description |
|---|---|
| Task |
Overrides
OnRead(SoDataReader, short)
Subclass contract: Create a new item. For each row read, we construct a simple List item based on the id, name and tooltip. Ranks
Declaration
protected override ISoListItem OnRead(SoDataReader reader, short lastRank)
Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | |
| short | lastRank |
Returns
| Type | Description |
|---|---|
| ISoListItem |
Overrides
SetSearchRestrictionAsync(Select, string)
Subclass contract: Set restriction in case of search. This method is always called, but we only set a restriction (on start with name) if there is nonempty string.
Declaration
protected override Task SetSearchRestrictionAsync(Select sql, string searchValue)
Parameters
| Type | Name | Description |
|---|---|---|
| Select | sql | Query to modify |
| string | searchValue | Search value to set |
Returns
| Type | Description |
|---|---|
| Task |