Class EjCategoryProvider

[MDOProviderPlugin("EjCategory")]
[MDOAdditionalInfoSeparator("&")]
[MDOAdditionalInfo("hierarchy", "Use hierarchy", "true")]
[MDOAdditionalInfo("onlyOwnCategories", "Return only categories owned by requester", false)]
[MDOAdditionalInfo("shortNames", "Return short names instead of full path", false)]
[MDOAdditionalInfo("shortTooltip", "Return short text (FullName) as a tooltip", false)]
[MDOAdditionalInfo("includeAdministrativeInfo", "Include admin UI info: resolve Category master name and icons", true)]
[MDONoSelectionId(-1)]
public class EjCategoryProvider : AnyTableListProviderBase, ISoListProvider, ISoList, IPlugin

Constructors

EjCategoryProvider()

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

Declaration

public EjCategoryProvider()

Fields

_hierarchy

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

Declaration

protected bool _hierarchy

Field Value

Type	Description
Boolean

_includeAdministrativeInfo

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

Declaration

protected bool _includeAdministrativeInfo

Field Value

Type	Description
Boolean

_onlyOwnCategories

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

Declaration

protected bool _onlyOwnCategories

Field Value

Type	Description
Boolean

_personTableInfo

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

Declaration

protected PersonTableInfo _personTableInfo

Field Value

Type	Description
PersonTableInfo

_shortNames

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

Declaration

protected bool _shortNames

Field Value

Type	Description
Boolean

_shortTooltip

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

Declaration

protected bool _shortTooltip

Field Value

Type	Description
Boolean

_tableInfo

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

Declaration

protected EjCategoryTableInfo _tableInfo

Field Value

Type	Description
EjCategoryTableInfo

ProviderName

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

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

AnyTableListProviderBase.TableInfo

Methods

ExecuteReader(SoCommand)

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

Declaration

protected override SoDataReader ExecuteReader(SoCommand cmd)

Parameters

Type	Name	Description
SoCommand	cmd

Returns

Type	Description
SoDataReader

Overrides

AnyTableListProviderBase.ExecuteReader(SoCommand)

GetMainQuery()

Get the main query for the list.

Declaration

protected override Select GetMainQuery()

Returns

Type	Description
Select

Overrides

AnyTableListProviderBase.GetMainQuery()

Init()

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

Declaration

protected override void Init()

Overrides

AnyTableListProviderBase.Init()

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

AnyTableListProviderBase.OnPostGetRootItems(List<ISoListItem>)

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

AnyTableListProviderBase.OnRead(SoDataReader, Int16)

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

AnyTableListProviderBase.SetSearchRestriction(Select, String)

Implements

ISoListProvider

ISoList

Extension Methods

EnumUtil.MapEnums<From, To>(From)

ObjectExtensions.AssignByReflection<T>(T, T)

ObjectExtensions.GraphCopy<T>(T)

Converters.MapEnums<From, To>(From)