Interface IArchiveProviderHasColumns

This interface defines the archive provider property of having display columns. The standard base class implements this interface. Actual functionality is found in the ColumnHelper class.

Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
public interface IArchiveProviderHasColumns

Methods

GetAvailableColumns()

Get the list of columns handled by this provider

Declaration
List<ArchiveColumnInfo> GetAvailableColumns()
Returns
Type Description
List<ArchiveColumnInfo>
| Edit

SetDesiredColumns(String[])

Set which columns should actually be returned, must be a subset of the GetAvailableColumns result.

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

Array of column ID's representing the desired columns

SetOrderBy(ArchiveOrderByInfo[])

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

Array of order by items

SetRestriction(ArchiveRestrictionInfo[])

Set query restriction globally, supersedes previous restrictions

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

Array of restrictions, with an implicit AND between them
Returns
Type Description
Boolean

true if at least one of the restrictions matched one of the available columns of the provider

Extension Methods

EnumUtil.MapEnums<From, To>(From)