Class StatusDefProvider

Return list of status monitors defined in the system. Additional info query parameter = "Contact" or "project".

Inheritance
Object
AnyTableListProviderBase
StatusDefProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("StatusDef")]
[MDOAdditionalInfoSeparator("&")]
[MDOAdditionalInfo("GetDeletedStatusDefs", "Include deleted records", true)]
[MDOAdditionalInfo("GetOwnerTable", "Name of owner table", "Project")]
public class StatusDefProvider : AnyTableListProviderBase, ISoListProvider, ISoList, IPlugin
Examples

Example of AdditionalInfo:

    GetOwnerTable=project&GetDeletedStatusDefs=true

Constructors

StatusDefProvider()

Return list of status monitors defined in the system. Additional info query parameter = "Contact" or "project".

Declaration
public StatusDefProvider()
Examples

Example of AdditionalInfo:

    GetOwnerTable=project&GetDeletedStatusDefs=true

Fields

ProviderName

Provider name

Declaration
public const string ProviderName = "StatusDef"
Field Value
Type Description
String
Examples

Example of AdditionalInfo:

    GetOwnerTable=project&GetDeletedStatusDefs=true

Properties

HistoryInfo

Return list of status monitors defined in the system. Additional info query parameter = "Contact" or "project".

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

Example of AdditionalInfo:

    GetOwnerTable=project&GetDeletedStatusDefs=true

TableInfo

Main table info used in the selection query.
This table info is used for getting history items.

Declaration
protected override TableInfo TableInfo { get; }
Property Value
Type Description
TableInfo
Overrides
Examples

Example of AdditionalInfo:

    GetOwnerTable=project&GetDeletedStatusDefs=true

Methods

GetHistoryItems()

No history on this table

Declaration
protected override List<ISoListItem> GetHistoryItems()
Returns
Type Description
List<ISoListItem>
Overrides
Examples

Example of AdditionalInfo:

    GetOwnerTable=project&GetDeletedStatusDefs=true

GetMainQuery()

Obtain the main query for the selection

Declaration
protected override Select GetMainQuery()
Returns
Type Description
Select

Main query for the selection.
Overrides
Examples

Example of AdditionalInfo:

    GetOwnerTable=project&GetDeletedStatusDefs=true

Init()

Return list of status monitors defined in the system. Additional info query parameter = "Contact" or "project".

Declaration
protected override void Init()
Overrides
Examples

Example of AdditionalInfo:

    GetOwnerTable=project&GetDeletedStatusDefs=true

OnRead(SoDataReader, Int16)

Handle reading of each item in the selection list

Declaration
protected override ISoListItem OnRead(SoDataReader reader, short lastRank)
Parameters
Type Name Description
SoDataReader reader

Reader exposing data read from the database.
Int16 lastRank

Last rank used when populating the list.
Returns
Type Description
ISoListItem

List item objects
Overrides
Examples

Example of AdditionalInfo:

    GetOwnerTable=project&GetDeletedStatusDefs=true

SetSearchRestriction(Select, String)

Set search restriction on the selection.

Declaration
protected override void SetSearchRestriction(Select sql, string searchValue)
Parameters
Type Name Description
Select sql

Sql to modify
String searchValue

value of the search restriction.
Overrides
Examples

Example of AdditionalInfo:

    GetOwnerTable=project&GetDeletedStatusDefs=true

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)