Class ArchiveEntitiesProviderBase

Inheritance
object
ArchiveConfigurationProviderBase
ArchiveEntitiesProviderBase
ChooseEntityProvider
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
public abstract class ArchiveEntitiesProviderBase : ArchiveConfigurationProviderBase, IDynamicMDOProvider, ISoListProvider, ISoList

Constructors

ArchiveEntitiesProviderBase()

Declaration
protected ArchiveEntitiesProviderBase()

Properties

InternalNamePrefix

This property should return the name prefix used to build the SoList provider name from the archive data provider name

Declaration
protected override string InternalNamePrefix { get; }
Property Value
Type Description
string
Overrides

NamePrefix

The prefix used to differentiate our lists from all other MDO lists. To avoid naming collisions, if an archive is called 'activity' then the list we generate here will be called NamePrefix+'activity'. SupportedLists returns a list of the names we support (including prefix).

Declaration
public static string NamePrefix { get; }
Property Value
Type Description
string

Methods

AcceptEntity(ArchiveRowTypeInfo)

Declaration
protected abstract bool AcceptEntity(ArchiveRowTypeInfo entity)
Parameters
Type Name Description
ArchiveRowTypeInfo entity
Returns
Type Description
bool

BuildItem(int, ArchiveRowTypeInfo)

Declaration
protected virtual ISoListItem BuildItem(int id, ArchiveRowTypeInfo entity)
Parameters
Type Name Description
int id
ArchiveRowTypeInfo entity
Returns
Type Description
ISoListItem

BuildListAsync(string, string, string, bool, CancellationToken)

This method is called during stage 2 of the two-phase construction process (from the ConstructAsync(string, string, int[], bool, string, bool, CancellationToken) method). The actual implementation of the list construction, including new'ing the _rootItems and _headingItems collections should be placed in this method. Note that _historyItems is by default always empty for this kind of list, so it is pre-allocated as such by this base class; implementers can override this behaviour if it makes sense to them.

Declaration
protected override Task BuildListAsync(string providerName, string guiControl, string searchValue, bool forceFlatList, CancellationToken cancellationToken)
Parameters
Type Name Description
string providerName
string guiControl

Name of GUI control, if provided by caller
string searchValue

Search value, if provided by caller
bool forceFlatList

Should the resulting list be forced to flat format (root items only)
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides

Implements

Extension Methods