Class AggregationProvider2

This is the main aggregation engine for the Archive Provider system - version 2, with built-in buffering and recursive evaluation

Inheritance
Object
AggregationProvider2
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists.Aggregation
Assembly: SoDataBase.dll
Syntax
[NoAggregation]
[ArchiveProvider("AggregationWrapper2", 1073741823)]
public class AggregationProvider2 : IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities, IPlugin
Remarks

This class is designed to wrap any other archive provider, and introduce the concepts of grouping and aggregation. Think of it as a report generator without the layout part + analytics cube engine.

Constructors

AggregationProvider2(IArchiveProvider)

Constructor, takes the inner provider as mandatory parameter, and discovers aggregator plugins

Declaration
public AggregationProvider2(IArchiveProvider dataProvider)
Parameters
Type Name Description
IArchiveProvider dataProvider

Fields

GrandTotalOption

Declaration
public const string GrandTotalOption = "GrandTotal"
Field Value
Type Description
String

NeedNoRowSentryOpton

Declaration
public const string NeedNoRowSentryOpton = "NeedNoRowSentry"
Field Value
Type Description
String

ProviderName

Declaration
public const string ProviderName = "AggregationWrapper2"
Field Value
Type Description
String

Methods

Close()

Declaration
public void Close()

GetAvailableColumns()

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

GetAvailableEntities()

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

GetReader(String)

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

GetResultInformation()

Declaration
public ArchiveResultInformation GetResultInformation()
Returns
Type Description
ArchiveResultInformation

GetRows(String)

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

SetDesiredColumns(String[])

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

SetDesiredEntities(String[])

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

SetOrderBy(ArchiveOrderByInfo[])

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

SetPagingInfo(Int32, Int32)

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

SetRestriction(ArchiveRestrictionInfo[])

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

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)