Class RelationListProvider

MDO list provider for contact/person relation definitions. This provider is a takes a mandatory additionalInfo parameter, that specifies what kind of relation should be fetched.

Inheritance
System.Object
MDOProviderBase
RelationListProvider
Implements
System.Collections.Generic.IEnumerable<ISoListItem>
System.Collections.IEnumerable
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("ContactRelationDefinition")]
[MDOAdditionalInfo("RelationType enum value. CC=Contact-Contact relations", "CC")]
public class RelationListProvider : MDOProviderBase, ISoListProvider, ISoList, IPlugin, IEnumerable<ISoListItem>, IEnumerable
Remarks

AdditionalInfo can be one of 'CC', 'CP', 'PC', 'PP', specifying contact or person on the source and destination sides of the relation. A join is made to the relationTarget table to pick out the correct relation definitions to show. The RelationListProvider.RelationType enum can be used to avoid strings when specifying the relation type.

The extraInfo field in the items contains the passive (reverse) text, useful for display.

Constructors

RelationListProvider()

Declaration
public RelationListProvider()

Fields

ProviderName

Declaration
public const string ProviderName = "ContactRelationDefinition"
Field Value
Type Description
System.String

Properties

HistoryInfo

History information for the list

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

Methods

Construct(String, String, Int32[], Boolean, String, Boolean)

Parse the desired relation type; pass on the physical table name to the base class, and (indirectly) construct the list

Declaration
public override void Construct(string tableName, string additionalInfo, int[] historyIDs, bool onlyReadHistory, string searchValue, bool forceFlatList)
Parameters
Type Name Description
System.String tableName
System.String additionalInfo
System.Int32[] historyIDs
System.Boolean onlyReadHistory
System.String searchValue
System.Boolean forceFlatList
Overrides

GetItemExtraInfo(ListTableRow)

Override: Fetch the passive_text field as the extraInfo

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

GetItemIconHint(ListTableRow)

Declaration
protected override string GetItemIconHint(ListTableRow row)
Parameters
Type Name Description
ListTableRow row
Returns
Type Description
System.String
Overrides

GetItemsAndHeadingsQuery()

Override: Add our extra join, restriction and fields to a headings/items list query

Declaration
protected override ListTableRows.CustomSearch GetItemsAndHeadingsQuery()
Returns
Type Description
ListTableRows.CustomSearch
Overrides

GetSimpleListQuery()

Override: Add our extra join, restriction and fields to a simple list query

Declaration
protected override ListTableRows.CustomSearch GetSimpleListQuery()
Returns
Type Description
ListTableRows.CustomSearch
Overrides

Implements

System.Collections.Generic.IEnumerable<>
System.Collections.IEnumerable

Extension Methods

EnumUtil.MapEnums<From, To>(From)