Class AvailableReportsProvider
AvailableReportsProvider creates an MDO list containing the available reports. The available reports are either the standard SuperOffice reports, the reports defined in ReporterStudio, or the favorites for each user as defined in SuperOffice.
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("AvailableReports")]
[MDOAdditionalInfo("Report category enum value. Contact=2, Sale reports=4, etc", 2)]
public class AvailableReportsProvider : AnyTableListProviderBase, ISoListProvider, ISoList, IPluginConstructors
AvailableReportsProvider()
AvailableReportsProvider creates an MDO list containing the available reports. The available reports are either the standard SuperOffice reports, the reports defined in ReporterStudio, or the favorites for each user as defined in SuperOffice.
Declaration
public AvailableReportsProvider()Fields
ProviderName
AvailableReportsProvider creates an MDO list containing the available reports. The available reports are either the standard SuperOffice reports, the reports defined in ReporterStudio, or the favorites for each user as defined in SuperOffice.
Declaration
public const string ProviderName = "AvailableReports"Field Value
| Type | Description |
|---|---|
| String |
Properties
TableInfo
AvailableReportsProvider creates an MDO list containing the available reports. The available reports are either the standard SuperOffice reports, the reports defined in ReporterStudio, or the favorites for each user as defined in SuperOffice.
Declaration
protected override TableInfo TableInfo { get; }Property Value
| Type | Description |
|---|---|
| TableInfo |
Overrides
Methods
GetMainQuery()
Creates a Select object that defines the query that gets the available reports
Declaration
protected override Select GetMainQuery()Returns
| Type | Description |
|---|---|
| Select |
Overrides
Init()
AvailableReportsProvider creates an MDO list containing the available reports. The available reports are either the standard SuperOffice reports, the reports defined in ReporterStudio, or the favorites for each user as defined in SuperOffice.
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 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 SORPublishTableInfo 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 starting string of the field |