Class SaleStageProvider

Provider for selecting a stage. AdditionalInfo is used as criteria to filter stages based on SaleType.

Inheritance
object
MDOProviderBase
GuideStepProvider
SaleStageProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("SaleStage")]
[MDOAdditionalInfoSeparator("&")]
[MDOAdditionalInfo("SaleTypeID", "Sale type to get stages for", "1234")]
[MDOAdditionalInfo("SaleTypeIDs", "Sale types to get stages for", "1,2,3,4")]
[MDOAdditionalInfo("GetDeletedStages", "Include deleted stages", true)]
[MDOAdditionalInfo("GetDeletedStageLinks", "Filter out deleted sale stage links", false)]
[MDOAdditionalInfo("HideOptionalRows", "Filter out optional stages", false)]
public class SaleStageProvider : GuideStepProvider, ISoListProvider, ISoList, IEnumerable<ISoListItem>, IEnumerable
Remarks

Sold(-2) and Lost(-1) items are appended at the end of the list.

AdditionalInfo "SaleTypeID=123&GetDeletedStages=true&HideOptionalRows=false&GetDeletedStageLinks=true"

Constructors

SaleStageProvider()

Provider for selecting a stage. AdditionalInfo is used as criteria to filter stages based on SaleType.

Declaration
public SaleStageProvider()
Remarks

Sold(-2) and Lost(-1) items are appended at the end of the list.

AdditionalInfo "SaleTypeID=123&GetDeletedStages=true&HideOptionalRows=false&GetDeletedStageLinks=true"

Fields

ProviderName

Provider name

Declaration
public const string ProviderName = "SaleStage"
Field Value
Type Description
string
Remarks

Sold(-2) and Lost(-1) items are appended at the end of the list.

AdditionalInfo "SaleTypeID=123&GetDeletedStages=true&HideOptionalRows=false&GetDeletedStageLinks=true"

Methods

BuildMdoCollectionsAsync(CancellationToken)

Convert rows object to ISoList collections

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

Sold(-2) and Lost(-1) items are appended at the end of the list.

AdditionalInfo "SaleTypeID=123&GetDeletedStages=true&HideOptionalRows=false&GetDeletedStageLinks=true"

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
Remarks

Sold(-2) and Lost(-1) items are appended at the end of the list.

AdditionalInfo "SaleTypeID=123&GetDeletedStages=true&HideOptionalRows=false&GetDeletedStageLinks=true"

GetItemExtraInfo(ListTableRow)

Provides a info regarding the deleted/not deleted state of a ListTableRow

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

The row in question
Returns
Type Description
string

A string with details on the state of the row (sub classes might add info to this string)
Overrides
Remarks

Sold(-2) and Lost(-1) items are appended at the end of the list.

AdditionalInfo "SaleTypeID=123&GetDeletedStages=true&HideOptionalRows=false&GetDeletedStageLinks=true"

GetRankField()

The sub class must provide the rank field of the main table. This field is used for sorting by the base class

Declaration
protected override FieldInfo GetRankField()
Returns
Type Description
FieldInfo

The Rank FieldInfo object
Overrides
Remarks

Sold(-2) and Lost(-1) items are appended at the end of the list.

AdditionalInfo "SaleTypeID=123&GetDeletedStages=true&HideOptionalRows=false&GetDeletedStageLinks=true"

GetSimpleListQueryAsync(CancellationToken)

Provider for selecting a stage. AdditionalInfo is used as criteria to filter stages based on SaleType.

Declaration
protected override Task<ListTableRows.CustomSearch> GetSimpleListQueryAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ListTableRows.CustomSearch>
Overrides
Remarks

Sold(-2) and Lost(-1) items are appended at the end of the list.

AdditionalInfo "SaleTypeID=123&GetDeletedStages=true&HideOptionalRows=false&GetDeletedStageLinks=true"

Implements

Extension Methods