Show / Hide Table of Contents

Class VisibleForAssociateMDOProvider

List provider that returns a list suitable for VisibleFor and PinTo (with groups and possibly some other special items like All).

Inheritance
object
MDOProviderBase
AssociateMDOProviderBase
VisibleForAssociateMDOProvider
Implements
ISoListProvider
ISoList
IEnumerable<ISoListItem>
IEnumerable
Inherited Members
AssociateMDOProviderBase._additionalInfo_GetDeleted
AssociateMDOProviderBase._additionalInfo_AddBinaryIconHints
AssociateMDOProviderBase._AdditionalInfo
AssociateMDOProviderBase.GetItemIconHint(ListTableRow)
AssociateMDOProviderBase.GetHeadingIconHint(ListTableRow)
AssociateMDOProviderBase.GetItemType(ListTableRow)
AssociateMDOProviderBase.GetItemTooltip(ListTableRow)
AssociateMDOProviderBase.GetHeadingType(ListTableRow)
AssociateMDOProviderBase.GetHistoryIconHint(ListTableRow)
AssociateMDOProviderBase.OnAddHeadingElementToCollection(SoListHeading)
AssociateMDOProviderBase.OnAddHistoryElementToCollection(SoListItem)
AssociateMDOProviderBase.OnAddSubItemToCollection(SoListItem, List<ISoListItem>)
AssociateMDOProviderBase.GetHistoryCollectionAsync(CancellationToken)
AssociateMDOProviderBase.AcceptHistoryRow(ListTableRow)
AssociateMDOProviderBase.ReadItemsAndHeadingsAsync(CancellationToken)
AssociateMDOProviderBase.GetSimpleListQueryAsync(CancellationToken)
AssociateMDOProviderBase.ReadSimpleListAsync(CancellationToken)
AssociateMDOProviderBase.GetItemsAndHeadingsQueryAsync(CancellationToken)
AssociateMDOProviderBase.GetAssociateFlatListAsync(CancellationToken)
AssociateMDOProviderBase.GetAssociateHeadingAndItemsAsync(CancellationToken)
AssociateMDOProviderBase.ExecuteQuery(Select, List<int>)
AssociateMDOProviderBase.ExecuteReader(SoCommand)
AssociateMDOProviderBase.ResortFlattenedListAsync(CancellationToken)
AssociateMDOProviderBase.HistoryInfo
AssociateMDOProviderBase.PersonTableInfo
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.AddSimpleListOrderByAsync(ListTableRows.CustomSearch, CancellationToken)
MDOProviderBase.GetItemsAndHeadingsQueryAsync(bool, CancellationToken, params int[])
MDOProviderBase.AddGroupLinkJoin(int[], ListTableRows.CustomSearch)
MDOProviderBase.GetItemId(ListTableRow)
MDOProviderBase.GetItemRank(ListTableRow)
MDOProviderBase.GetItemDeleted(ListTableRow)
MDOProviderBase.GetItemColor(ListTableRow)
MDOProviderBase.GetItemStyleHint(ListTableRow)
MDOProviderBase.OnAddRootElementToCollection(SoListItem)
MDOProviderBase.GetListLowerLimitAsync(CancellationToken)
MDOProviderBase.GetPreferredSortOrderAsync(CancellationToken)
MDOProviderBase.BuildMdoCollectionsAsync(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("visibleforassociate")]
[MDOAdditionalInfo("ContactName", "Add the company name in parenthesis.", false)]
[MDOAdditionalInfo("includeHasEmail", "Include has_email in extrainfo", false)]
public class VisibleForAssociateMDOProvider : AssociateMDOProviderBase, ISoListProvider, ISoList, IEnumerable<ISoListItem>, IEnumerable

Fields

ContactNameAdditionalInfo

List provider that returns a list suitable for VisibleFor and PinTo (with groups and possibly some other special items like All).

Declaration
public const string ContactNameAdditionalInfo = "ContactName"
Field Value
Type Description
string

IncludeHasEmail

List provider that returns a list suitable for VisibleFor and PinTo (with groups and possibly some other special items like All).

Declaration
public const string IncludeHasEmail = "includeHasEmail"
Field Value
Type Description
string

ProviderName

List provider that returns a list suitable for VisibleFor and PinTo (with groups and possibly some other special items like All).

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

_contactTableInfo

List provider that returns a list suitable for VisibleFor and PinTo (with groups and possibly some other special items like All).

Declaration
protected ContactTableInfo _contactTableInfo
Field Value
Type Description
ContactTableInfo

_emailTableInfo

List provider that returns a list suitable for VisibleFor and PinTo (with groups and possibly some other special items like All).

Declaration
protected EmailTableInfo _emailTableInfo
Field Value
Type Description
EmailTableInfo

Methods

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

Phase two of the two-phase construction

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
string additionalInfo
int[] historyIDs
bool onlyReadHistory
string searchValue
bool forceFlatList
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides
AssociateMDOProviderBase.ConstructAsync(string, string, int[], bool, string, bool, CancellationToken)

FillListAsync(CancellationToken)

Fill the list with items Filtering out duplicate person id's if the additional info specifies that we should include an email join

Declaration
protected override Task FillListAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides
MDOProviderBase.FillListAsync(CancellationToken)

GenerateCommonQueryAsync(CustomSearch, ListInfo, CancellationToken)

List provider that returns a list suitable for VisibleFor and PinTo (with groups and possibly some other special items like All).

Declaration
protected override Task GenerateCommonQueryAsync(ListTableRows.CustomSearch query, ListInfo li, CancellationToken cancellationToken)
Parameters
Type Name Description
ListTableRows.CustomSearch query
ListInfo li
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides
AssociateMDOProviderBase.GenerateCommonQueryAsync(ListTableRows.CustomSearch, ListInfo, CancellationToken)

GetGroupingAllowedForListAsync(CancellationToken)

List provider that returns a list suitable for VisibleFor and PinTo (with groups and possibly some other special items like All).

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

GetItemExtraInfo(ListTableRow)

List provider that returns a list suitable for VisibleFor and PinTo (with groups and possibly some other special items like All).

Declaration
protected override string GetItemExtraInfo(ListTableRow row)
Parameters
Type Name Description
ListTableRow row
Returns
Type Description
string
Overrides
AssociateMDOProviderBase.GetItemExtraInfo(ListTableRow)

GetItemName(ListTableRow)

Get the name of an item

Declaration
protected override string GetItemName(ListTableRow row)
Parameters
Type Name Description
ListTableRow row
Returns
Type Description
string
Overrides
AssociateMDOProviderBase.GetItemName(ListTableRow)

Implements

ISoListProvider
ISoList
IEnumerable<T>
IEnumerable

Extension Methods

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