Class FunctionRightsListProvider
FunctionRightsListProvider returns a MDO list of function rights in the database. Additional Info = "role=123;languageId=1024;roleType=1"
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("FunctionRights")]
[MDOAdditionalInfoSeparator(";")]
[MDOAdditionalInfo("role", "Restrict to a specific role", 123)]
[MDOAdditionalInfo("roleType", "Restrict to rights for a given roleType", 1)]
[MDOAdditionalInfo("languageId", "Language to return results in. English=1033", 1033)]
public class FunctionRightsListProvider : AnyTableListProviderBase, ISoListProvider, ISoList, IPluginConstructors
FunctionRightsListProvider()
Default constructor
Declaration
public FunctionRightsListProvider()Fields
ProviderName
The name of the provider.
Declaration
public const string ProviderName = "FunctionRights"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) functional rights. Need "all" rows, not the global prefenrence size for grouped lists
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. Additional Info = "role=123;languageId=1024;roleType=1"
Declaration
protected override Select GetMainQuery()Returns
| Type | Description |
|---|---|
| Select |
Overrides
Init()
Initiate the provider after the
Declaration
protected override void Init()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 read 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 |