Class ReportProvider

This archive provider is made for getting the available criteria for a given report. The report id is set when instanciating the object through the

Inheritance
object
ReportProvider
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
[ArchiveProvider("ReportProvider", 1073741823)]
public class ReportProvider : IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities

Constructors

ReportProvider(string)

This provider cannot be instanciated without it's input parameter.

Declaration
public ReportProvider(string id)
Parameters
Type Name Description
string id

If this parameter (even though it's a string) does not parse into an integer, subsequent calls to GetAvailableColumns will couse an exception to be thrown. The way to propperly instanciate a ReportProvider with an id is through the ArchiveProviderFactory 

int exampleReportId = 13 ; //this is just an example of a possible report id

        //This will create a ReportProvider with the report id 13. 
        IArchiveProvider reportProvider = ArchiveProviderFactory.Create(ReportProvider.ProviderName + ReportProvider.ReportIdDelimiter + exampleReportId.ToString());</code></pre>

Fields

ProviderName

This archive provider is made for getting the available criteria for a given report. The report id is set when instanciating the object through the

Declaration
public const string ProviderName = "ReportProvider"
Field Value
Type Description
string

ReportIdDelimiter

This archive provider is made for getting the available criteria for a given report. The report id is set when instanciating the object through the

Declaration
public const string ReportIdDelimiter = ":"
Field Value
Type Description
string

Methods

Close()

ReportProvider is meant to be used as a provider for getting the available columns (criteria) for a given report. You are not able to close it.

Declaration
public void Close()

GetAvailableColumns()

This method returns the available criteria for the report id this provider in instanciated with.

Declaration
public List<ArchiveColumnInfo> GetAvailableColumns()
Returns
Type Description
List<ArchiveColumnInfo>

A list of ArchiveColumnInfo objects reprsenting the available criteria.

GetAvailableEntities()

Get the list of entities supported by this provider

Declaration
public List<ArchiveRowTypeInfo> GetAvailableEntities()
Returns
Type Description
List<ArchiveRowTypeInfo>

The list of entities

GetReader(string)

Start the provider, returning an IDataReader compatible object to the client for row enumeration and data access

Declaration
public virtual IDataReader GetReader(string options)
Parameters
Type Name Description
string options

Options, passed to the internal GetRows method
Returns
Type Description
IDataReader

IDataReader primed to provide results

GetResultInformation()

Get additional information about the result, such as row count or other optional items. This method should be called some time after GetRows, but before Close. Delaying calls to this method as long as possible will give its (asynchronous) internal counterpart more time to complete and lessen the response-time impact of calling it.

Declaration
public ArchiveResultInformation GetResultInformation()
Returns
Type Description
ArchiveResultInformation

GetRows(string)

ReportProvider is meant to be used as a provider for getting the available columns (criteria) for a given report. You are not able to get rows from this provider, only columns

Declaration
public IEnumerable<ArchiveRow> GetRows(string options)
Parameters
Type Name Description
string options
Returns
Type Description
IEnumerable<ArchiveRow>

SetDesiredColumns(params string[])

ReportProvider is meant to be used as a provider for getting the available columns (criteria) for a given report. You are not able to set desired columns on this provider.

Declaration
public void SetDesiredColumns(params string[] columnIds)
Parameters
Type Name Description
string[] columnIds

SetDesiredEntities(params string[])

ReportProvider is meant to be used as a provider for getting the available columns (criteria) for a given report. You are not able to set the desired enities.

Declaration
public void SetDesiredEntities(params string[] entities)
Parameters
Type Name Description
string[] entities

SetOrderBy(params ArchiveOrderByInfo[])

ReportProvider is meant to be used as a provider for getting the available columns (criteria) for a given report. You are not able to set order by on this provider.

Declaration
public void SetOrderBy(params ArchiveOrderByInfo[] orderBy)
Parameters
Type Name Description
ArchiveOrderByInfo[] orderBy

SetPagingInfo(int, int)

ReportProvider is meant to be used as a provider for getting the available columns (criteria) for a given report. You are not able to set paging info on this provider.

Declaration
public void SetPagingInfo(int pageSize, int pageNumber)
Parameters
Type Name Description
int pageSize
int pageNumber

SetRestriction(ArchiveRestrictionInfo[])

ReportProvider is meant to be used as a provider for getting the available columns (criteria) for a given report. Therefor you are not able to set any restrictions

Declaration
public bool SetRestriction(ArchiveRestrictionInfo[] restrictions)
Parameters
Type Name Description
ArchiveRestrictionInfo[] restrictions
Returns
Type Description
bool

Implements

Extension Methods