Class EjCategoryProvider

EjCategoryProvider creates a flat or tree list based on the table: EJ_CATEGORY

Inheritance
Object
AnyTableListProviderBase
EjCategoryProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("EjCategory")]
[MDOAdditionalInfoSeparator("&")]
[MDOAdditionalInfo("hierarchy", "Use hierarchy", "true")]
[MDOAdditionalInfo("shortNames", "Return short names instead of full path", "false")]
[MDONoSelectionId(-1)]
public class EjCategoryProvider : AnyTableListProviderBase, ISoListProvider, ISoList, IPlugin

Constructors

EjCategoryProvider()

Declaration
public EjCategoryProvider()

Fields

_hierarchy

Declaration
protected bool _hierarchy
Field Value
Type Description
Boolean

_shortNames

Declaration
protected bool _shortNames
Field Value
Type Description
Boolean

_tableInfo

Declaration
protected EjCategoryTableInfo _tableInfo
Field Value
Type Description
EjCategoryTableInfo

ProviderName

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

Properties

TableInfo

The table info of the query. This is used by subclasses (e.g. this class) when restricting history data.

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

Methods

ExecuteReader(SoCommand)

Declaration
protected override SoDataReader ExecuteReader(SoCommand cmd)
Parameters
Type Name Description
SoCommand cmd
Returns
Type Description
SoDataReader
Overrides

GetMainQuery()

Get the main query for the list.

Declaration
protected override Select GetMainQuery()
Returns
Type Description
Select
Overrides

Init()

Initiate the provider after the Construct(String, String, Int32[], Boolean, String, Boolean) method is called.

Declaration
protected override void Init()
Overrides

OnPostGetRootItems(List<ISoListItem>)

Make the tree structure if necessary

Declaration
protected override void OnPostGetRootItems(List<ISoListItem> items)
Parameters
Type Name Description
List<ISoListItem> items
Overrides

OnRead(SoDataReader, Int16)

Raised every time a new row has been read from the database.
The implementation should read the results from the reader and populate an object implementing ISoListItem.

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

Reader to reaf from.
Int16 lastRank

Value of the last rank populated.
Returns
Type Description
ISoListItem

Data read from the reader.
Overrides

SetSearchRestriction(Select, String)

Set the search restriction on the list.

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

Query to set the search restriction on.
String searchValue

The value of the search restriction.
Overrides

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)