Show / Hide Table of Contents

Interface IAggregationPlugin

Interface for plugins to the aggregation system in archives. Except for the special GroupAggregation, aggregators accumulate or modify values

Namespace: SuperOffice.CRM.ArchiveLists.Aggregation
Assembly: SoDataBase.dll
Syntax
public interface IAggregationPlugin : IPlugin

Methods

AddItem(ArchiveColumnData)

Accept one item, and return its replacement (output in the detail row)

Declaration
ArchiveColumnData AddItem(ArchiveColumnData item)
Parameters
Type Name Description
ArchiveColumnData item
Returns
Type Description
ArchiveColumnData

This value will be output in the current detail row. It can be the incoming item unchaged, a transformation of it, or the current (running) value of the aggregate - it all depends on the precise function the aggregator

AddItem(ArchiveColumnData[])

Accept an array of items, and return one field

Declaration
ArchiveColumnData AddItem(ArchiveColumnData[] items)
Parameters
Type Name Description
ArchiveColumnData[] items
Returns
Type Description
ArchiveColumnData

This value will be output in the current detail row. It can be one of the the incoming items unchanged, a transformation of them, or the current (running) value of the aggregate - it all depends on the precise function the aggregator

GetAggregatedValue()

Return the aggregate value (output in the footer)

Declaration
ArchiveColumnData GetAggregatedValue()
Returns
Type Description
ArchiveColumnData

SetModifiers(String[])

Accept modifiers in the column definition

Declaration
void SetModifiers(string[] modifiers)
Parameters
Type Name Description
String[] modifiers

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top