Show / Hide Table of Contents

Class UserPlanProvider

List provider for the UserPlan in the module license table. Returns all user plans except the one specified by additional-info "exclude_id"

Inheritance
Object
AnyTableListProviderBase
UserPlanProvider
Implements
ISoListProvider
ISoList
Inherited Members
AnyTableListProviderBase.Construct(String, String, Int32[], Boolean, String, Boolean)
AnyTableListProviderBase.GetHistoryItems()
AnyTableListProviderBase.GetRootItems()
AnyTableListProviderBase.OnPostGetRootItems(List<ISoListItem>)
AnyTableListProviderBase.SetHistoryRestriction(Select)
AnyTableListProviderBase.ExecuteQuery(Select, List<ISoListItem>)
AnyTableListProviderBase.ExecuteReader(SoCommand)
AnyTableListProviderBase.ListName
AnyTableListProviderBase.AdditionalInfo
AnyTableListProviderBase.HistoryIDs
AnyTableListProviderBase.OnlyReadHistory
AnyTableListProviderBase.SearchValue
AnyTableListProviderBase.ForceFlatList
AnyTableListProviderBase.HistoryInfo
AnyTableListProviderBase.HistoryItems
AnyTableListProviderBase.RootItems
AnyTableListProviderBase.HeadingItems
Object.ToString()
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("UserPlan")]
[MDOAdditionalInfo("exclude_id", "Exclude the given user-plan by id", 1234)]
public class UserPlanProvider : AnyTableListProviderBase, ISoListProvider, ISoList, IPlugin

Constructors

UserPlanProvider()

Declaration
public UserPlanProvider()

Fields

ProviderName

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

Properties

TableInfo

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

Methods

GetMainQuery()

Subclass contract: Get main query. We only fetch the neeeded fields, and use ascending sort by name, always

Declaration
protected override Select GetMainQuery()
Returns
Type Description
Select

Query primed with return fields and orderby

Overrides
AnyTableListProviderBase.GetMainQuery()

Init()

Subclass contract: Initialize (nothing much here)

Declaration
protected override void Init()
Overrides
AnyTableListProviderBase.Init()

OnPreGetRootItems(List<ISoListItem>)

Event raised by after values are fetched from the database. Adding option for empty group at the beginning of list

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

List of items returned from .

Overrides
AnyTableListProviderBase.OnPreGetRootItems(List<ISoListItem>)

OnRead(SoDataReader, Int16)

Subclass contract: Create a new item. For each row read, we construct a simple List item based on the id, name and tooltip. Ranks

Declaration
protected override ISoListItem OnRead(SoDataReader reader, short lastRank)
Parameters
Type Name Description
SoDataReader reader
Int16 lastRank
Returns
Type Description
ISoListItem
Overrides
AnyTableListProviderBase.OnRead(SoDataReader, Int16)

SetSearchRestriction(Select, String)

Subclass contract: Set restriction in case of search. This method is always called, but we only set a restriction (on start with name) if there is nonempty string.

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

Query to modify

String searchValue

Search value to set

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)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top