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"
Inherited Members
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()
List provider for the UserPlan in the module license table. Returns all user plans except the one specified by additional-info "exclude_id"
Declaration
public UserPlanProvider()
Fields
ProviderName
List provider for the UserPlan in the module license table. Returns all user plans except the one specified by additional-info "exclude_id"
Declaration
public const string ProviderName = "UserPlan"
Field Value
Type | Description |
---|---|
String |
Properties
TableInfo
List provider for the UserPlan in the module license table. Returns all user plans except the one specified by additional-info "exclude_id"
Declaration
protected override TableInfo TableInfo { get; }
Property Value
Type | Description |
---|---|
TableInfo |
Overrides
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
Init()
Subclass contract: Initialize (nothing much here)
Declaration
protected override void Init()
Overrides
OnPreGetRootItems(List<ISoListItem>)
Event raised by
Declaration
protected override void OnPreGetRootItems(List<ISoListItem> items)
Parameters
Type | Name | Description |
---|---|---|
List<ISoListItem> | items | List of items returned from |
Overrides
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
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 |