Interface ISoListProviderFactory

Creates a MDOProvider

Namespace: SuperOffice.CRM.Lists

Assembly: SoDataBase.dll

Syntax

public interface ISoListProviderFactory

Properties

KnownHistoryInfos

Creates a MDOProvider

Declaration

Dictionary<string, HistoryInfo> KnownHistoryInfos { get; }

Property Value

Type	Description
Dictionary<string, HistoryInfo>

KnownListProviders

Return a list of the names of all known list providers

Declaration

List<string> KnownListProviders { get; }

Property Value

Type	Description
List<string>

KnownSoListProviders

Return a dictionary of all known list providers (name/SuperOffice.Factory.PluginInfo)

Declaration

Dictionary<string, PluginInfo> KnownSoListProviders { get; }

Property Value

Type	Description
Dictionary<string, PluginInfo>

Methods

CreateAsync(string, bool, CancellationToken)

Create an MDOProvider for an MDO list, and potentially force a flat output (no headings or history)

Declaration

Task<ISoListProvider> CreateAsync(string listName, bool forceFlatList, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	listName	Name of the list to create the MDO Provider for
bool	forceFlatList	If true, forces flat output. Filtering will still be performed if specified in SoAdmin.
CancellationToken	cancellationToken

Returns

Type	Description
Task<ISoListProvider>

CreateAsync(string, string, bool, bool, CancellationToken)

Create an MDOProvider, with additional information, potentially force only history to be read, potentially force flat output

Declaration

Task<ISoListProvider> CreateAsync(string listName, string additionalInfo, bool readOnlyHistory, bool forceFlatList, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	listName	Name of the list to create the MDO Provider for
string	additionalInfo	Additional information for the provider
bool	readOnlyHistory	If true, only history is read and returned
bool	forceFlatList	If true, forces flat output. Filtering will still be performed if specified in SoAdmin.
CancellationToken	cancellationToken

Returns

Type	Description
Task<ISoListProvider>	Provider

CreateAsync(string, string, bool, CancellationToken)

Create an MDOProvider, with additional information and possibly force flat output

Declaration

Task<ISoListProvider> CreateAsync(string listName, string additionalInfo, bool forceFlatList, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	listName	Name of the list to create the MDO Provider for
string	additionalInfo	Additional info for the provider
bool	forceFlatList	If true, forces flat output. Filtering will still be performed if specified in SoAdmin.
CancellationToken	cancellationToken

Returns

Type	Description
Task<ISoListProvider>	ISoListProvider

CreateAsync(string, string, int[], bool, bool, CancellationToken)

Create an MDOProvider, with additional information, an override of the history array, potentially force ONLY history to be returned, and potentially force flat output.

Declaration

Task<ISoListProvider> CreateAsync(string listName, string additionalInfo, int[] historyIds, bool readOnlyHistory, bool forceFlatList, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	listName	Name of the list to create the MDO Provider for
string	additionalInfo	Additional information for the provider
int[]	historyIds	Ids of list primary keys that represent the history; the history table is NOT read in this case. An array with zero elements will disable history fetching; a null parameter will instead cause history to be fetched from the database.
bool	readOnlyHistory	If true, only history is read and returned
bool	forceFlatList	If true, forces flat output. Filtering will still be performed if specified in SoAdmin.
CancellationToken	cancellationToken

Returns

Type	Description
Task<ISoListProvider>	Provider

CreateAsync(string, string, int[], bool, string, bool, CancellationToken)

Create an MDOProvider, with additional information, an override of the history array, potentially force ONLY history to be returned, potentially restrict output via a seach value, and potentially force flat output.

Declaration

Task<ISoListProvider> CreateAsync(string listName, string additionalInfo, int[] historyIDs, bool onlyReadHistory, string searchValue, bool forceFlatList, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	listName	Name of the list to create the MDO Provider for
string	additionalInfo	Additional information for the provider
int[]	historyIDs	Ids of list primary keys that represent the history; the history table is NOT read in this case. An array with zero elements will disable history fetching; a null parameter will instead cause history to be fetched from the database.
bool	onlyReadHistory	If true, only history is read and returned
string	searchValue	Value to search for
bool	forceFlatList	If true, forces flat output. Filtering will still be performed if specified in SoAdmin.
CancellationToken	cancellationToken

Returns

Type	Description
Task<ISoListProvider>	Provider

CreateAsync(string, string, int[], bool, CancellationToken)

Create an MDOProvider, with additional information, an override of the history array, and potentially force flat output

Declaration

Task<ISoListProvider> CreateAsync(string listName, string additionalInfo, int[] historyIds, bool forceFlatList, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	listName	Name of the list to create the MDO Provider for
string	additionalInfo	Additional info for the provider
int[]	historyIds	Ids of list primary keys that represent the history; the history table is NOT read in this case. An array with zero elements will disable history fetching; a null parameter will instead cause history to be fetched from the database.
bool	forceFlatList	If true, forces flat output. Filtering will still be performed if specified in SoAdmin.
CancellationToken	cancellationToken

Returns

Type	Description
Task<ISoListProvider>	ISoListProvider

CreateAsync(string, string, string, CancellationToken)

Create an MDOProvider, with additional information, and restrict the output to those items that match the given search value. The search algorithm is determined by the individual providers.

Declaration

Task<ISoListProvider> CreateAsync(string listName, string additionalInfo, string searchValue, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	listName	Name of the list to create the MDO Provider for
string	additionalInfo	Additional information for the provider
string	searchValue	Value to search for
CancellationToken	cancellationToken

Returns

Type	Description
Task<ISoListProvider>	Provider

CreateAsync(string, string, CancellationToken)

Create an MDOProvider for an MDO list, with additional information for the provider

Declaration

Task<ISoListProvider> CreateAsync(string listName, string additionalInfo, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	listName	Name of the list to create the MDO Provider for
string	additionalInfo	Additional information, passed to the provider factory and constructor
CancellationToken	cancellationToken

Returns

Type	Description
Task<ISoListProvider>

CreateAsync(string, CancellationToken)

Create an MDOProvider for an MDO list

Declaration

Task<ISoListProvider> CreateAsync(string listName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	listName	Name of the list to create the MDO Provider for
CancellationToken	cancellationToken

Returns

Type	Description
Task<ISoListProvider>	ISoListProvider with data from the table

Flush()

Flushes the MDOProvider plugin cache

Declaration

void Flush()

GetHistoryInformation(string)

Creates a MDOProvider

Declaration

HistoryInfo GetHistoryInformation(string listName)

Parameters

Type	Name	Description
string	listName

Returns

Type	Description
HistoryInfo

GetHistoryInformation(string, int)

Creates a MDOProvider

Declaration

HistoryInfo GetHistoryInformation(string tableName, int extraId)

Parameters

Type	Name	Description
string	tableName
int	extraId

Returns

Type	Description
HistoryInfo

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)