Class RolesListProvider
RoleListProvider creates a MDO list of roles in the database. Default list are the employee roles. Use ExtraInfo to get other RoleTypes. ExtraInfo : "0" Default, to get employee roles ExtraInfo : "1" to get external users roles ExtraInfo : "2" to get anonymous roles. ExtraInfo : "3" to get system user roles.
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("Roles")]
[MDOAdditionalInfoSeparator(";")]
[MDOAdditionalInfo("Role type (0=employees, 1=ext users, 2=anon, 3=system)", "0")]
public class RolesListProvider : AnyTableListProviderBase, ISoListProvider, ISoList, IPluginConstructors
RolesListProvider()
Default constructor
Declaration
public RolesListProvider()Fields
ProviderName
The name of the provider.
Declaration
public const string ProviderName = "Roles"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)
Overridden here to fetch all (500) roles. Mainly or only used in Admin, so need all rows, not only the amount specified in global preference MaxListSize
Declaration
protected override SoDataReader ExecuteReader(SoCommand cmd)Parameters
| Type | Name | Description |
|---|---|---|
| SoCommand | cmd |
Returns
| Type | Description |
|---|---|
| SoDataReader |
Overrides
GetMainQuery()
Get the query to retrieve roles in the database.
Declaration
protected override Select GetMainQuery()Returns
| Type | Description |
|---|---|
| Select |
Overrides
Init()
Initiate the provider after the
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)
Raised every time a new row has been read from the database.
The implementation should read tthe 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)
If the input searchValue enables searching on the RoleTableInfo Name field.
Declaration
protected override void SetSearchRestriction(Select sql, string searchValue)Parameters
| Type | Name | Description |
|---|---|---|
| Select | sql | The initial query |
| String | searchValue | This search value specifies the containing string of the field |