Interface ISoListProvider
Interface defining an MDO list provider, whose supported list (just one) is known at compile time. A class implementing this interface should also use the MDOProviderPluginAttribute to mark itself as a plugin, and it should implement the SuperOffice.Factory.IPlugin interface for the same reason. Note that the MDOProviderBase class implements all of these interface, so that a derived class only needs the attribute: Interface implementation requirements can be satisifed by base classes, while the attribute must be on the derived class.
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
public interface ISoListProvider : ISoListProperties
HistoryInfo
History information for the supported list
Declaration
HistoryInfo HistoryInfo { get; }Property Value
| Type | Description |
|---|---|
| HistoryInfo |
Methods
Construct(String, String, Int32[], Boolean, String, Boolean)
Phase two of two-stage list construction. To be called right after the constructor, at which point all constructors have run, and the class hierarchy is initialized.
Declaration
void Construct(string listName, string additionalInfo, int[] historyIDs, bool onlyReadHistory, string searchValue, bool forceFlatList)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | listName | List name (though note that as implemented by MDOProviderBase, this actually has to be a real table name, so subclasses should override and convert from their list name to a real table name) (yes it's a bit messy) |
| System.String | additionalInfo | Additional information to provider |
| System.Int32[] | historyIDs | Array of history ID's; if non-null, this will BE the history; a non-null but empty array will disable reading of history altogether; a null parameter will cause history to be read from the database. |
| Boolean | onlyReadHistory | if true, only history will be read. |
| System.String | searchValue | If non-null, the returned list will be flat and only consist of search matches |
| Boolean | forceFlatList | If true, the returned list will be flat, though it will still be filtered if grouping/filtering has been set up for the list |