Show / Hide Table of Contents

Class TaskProvider

Task table MDO list. Optional include "None" as first value.

Inheritance
object
MDOProviderBase
TaskProvider
Implements
ISoListProvider
ISoList
IEnumerable<ISoListItem>
IEnumerable
Inherited Members
MDOProviderBase._historyIds
MDOProviderBase._searchValue
MDOProviderBase._forceFlatList
MDOProviderBase._rootCollection
MDOProviderBase._historyCollection
MDOProviderBase._headingCollection
MDOProviderBase._declaredListName
MDOProviderBase._tableRows
MDOProviderBase._nodeType
MDOProviderBase._listName
MDOProviderBase._tableName
MDOProviderBase._tableListInfo
MDOProviderBase._listInfo
MDOProviderBase.FillListAsync(CancellationToken)
MDOProviderBase.GetHistoryCollectionAsync(CancellationToken)
MDOProviderBase.ReadSimpleListAsync(CancellationToken)
MDOProviderBase.ReadItemsAndHeadingsAsync(CancellationToken)
MDOProviderBase.GetSimpleListQueryAsync(CancellationToken)
MDOProviderBase.AddSimpleListOrderByAsync(ListTableRows.CustomSearch, CancellationToken)
MDOProviderBase.GetItemsAndHeadingsQueryAsync(CancellationToken)
MDOProviderBase.GetItemsAndHeadingsQueryAsync(bool, CancellationToken, params int[])
MDOProviderBase.AddGroupLinkJoin(int[], ListTableRows.CustomSearch)
MDOProviderBase.GetHeadingType(ListTableRow)
MDOProviderBase.GetItemId(ListTableRow)
MDOProviderBase.GetItemName(ListTableRow)
MDOProviderBase.AcceptHistoryRow(ListTableRow)
MDOProviderBase.GetHistoryIconHint(ListTableRow)
MDOProviderBase.GetItemTooltip(ListTableRow)
MDOProviderBase.GetItemRank(ListTableRow)
MDOProviderBase.GetItemDeleted(ListTableRow)
MDOProviderBase.GetItemStyleHint(ListTableRow)
MDOProviderBase.GetItemExtraInfo(ListTableRow)
MDOProviderBase.GetGroupingAllowedForListAsync(CancellationToken)
MDOProviderBase.OnAddRootElementToCollection(SoListItem)
MDOProviderBase.OnAddSubItemToCollection(SoListItem, List<ISoListItem>)
MDOProviderBase.OnAddHeadingElementToCollection(SoListHeading)
MDOProviderBase.OnAddHistoryElementToCollection(SoListItem)
MDOProviderBase.GetListLowerLimitAsync(CancellationToken)
MDOProviderBase.BuildMdoCollectionsAsync(CancellationToken)
MDOProviderBase.ResortFlattenedListAsync(CancellationToken)
MDOProviderBase.GetHistoryItemsAsync(CancellationToken)
MDOProviderBase.ClearHistoryItems()
MDOProviderBase.GetRootItemsAsync(CancellationToken)
MDOProviderBase.GetHeadingItemsAsync(CancellationToken)
MDOProviderBase.IncludeDeletedItems
MDOProviderBase.InhibitResortOnFlattening
MDOProviderBase.IsFinalListFlat
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.BusinessLogic.dll
Syntax
[MDOProviderPlugin("Task")]
[MDOAdditionalInfo("includeNone", "Include a NO-SELECTION item first", true)]
public class TaskProvider : MDOProviderBase, ISoListProvider, ISoList, IEnumerable<ISoListItem>, IEnumerable

Constructors

TaskProvider()

Task table MDO list. Optional include "None" as first value.

Declaration
public TaskProvider()

Fields

ProviderName

Task table MDO list. Optional include "None" as first value.

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

Properties

HistoryInfo

The HistoryInfo for the root provider is null; it's the HistoryInfo for our SupportedLists that is interesting

Declaration
public override HistoryInfo HistoryInfo { get; }
Property Value
Type Description
HistoryInfo
Overrides
MDOProviderBase.HistoryInfo

Methods

ConstructAsync(string, string, int[], bool, string, bool, CancellationToken)

Initializes all class members.

Declaration
public override Task ConstructAsync(string tableName, string additionalInfo, int[] historyIDs, bool onlyReadHistory, string searchValue, bool forceFlatList, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string tableName

Name of the table holding the MDO list values, like Category, Business, etc. Note that this really has to be a valid table name.

string additionalInfo
int[] historyIDs

List of history id's (primary keys of the table holding the MDO list values).

bool onlyReadHistory

Only read history nodes.

string searchValue

Search value (case insensetive string used like '%[searchValue]%'. The result when using this is allways a flat list without hisotry elements.

bool forceFlatList

State that a forced flat list should be returned.

CancellationToken cancellationToken
Returns
Type Description
Task
Overrides
MDOProviderBase.ConstructAsync(string, string, int[], bool, string, bool, CancellationToken)

GetHeadingIconHint(ListTableRow)

Get a value for the field IconHint in ISoList for a heading element

Declaration
protected override string GetHeadingIconHint(ListTableRow row)
Parameters
Type Name Description
ListTableRow row

The actual row for which the item is created

Returns
Type Description
string

An icon hint text

Overrides
MDOProviderBase.GetHeadingIconHint(ListTableRow)

GetItemColor(ListTableRow)

Task table MDO list. Optional include "None" as first value.

Declaration
protected override int GetItemColor(ListTableRow row)
Parameters
Type Name Description
ListTableRow row
Returns
Type Description
int
Overrides
MDOProviderBase.GetItemColor(ListTableRow)

GetItemIconHint(ListTableRow)

Get a value for the field IconHint in ISoList for an item element

Declaration
protected override string GetItemIconHint(ListTableRow row)
Parameters
Type Name Description
ListTableRow row

The actual row for which the item is created

Returns
Type Description
string

An icon hint text

Overrides
MDOProviderBase.GetItemIconHint(ListTableRow)

GetItemType(ListTableRow)

Get a value for the field Type in ISoList for an item element

Declaration
protected override string GetItemType(ListTableRow row)
Parameters
Type Name Description
ListTableRow row

The actual row for which the item is created

Returns
Type Description
string

The type of the list item

Overrides
MDOProviderBase.GetItemType(ListTableRow)

GetPreferredSortOrderAsync(CancellationToken)

Tell the provider that we want sorting by rank.

Declaration
protected override Task<MDOSortOrder> GetPreferredSortOrderAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<MDOSortOrder>
Overrides
MDOProviderBase.GetPreferredSortOrderAsync(CancellationToken)

Implements

ISoListProvider
ISoList
IEnumerable<T>
IEnumerable

Extension Methods

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