Class AliasProviderBase<AliasedType>
This base class implements a provider that is simply a facade for another provider. All methods
are virtual, with a base implementation that simply calls the aliased provider.
Inheritance
AliasProviderBase<AliasedType>
Assembly: SoDataBase.dll
Syntax
public abstract class AliasProviderBase<AliasedType> : IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities, IPlugin where AliasedType : IArchiveProvider
Type Parameters
Name |
Description |
AliasedType |
|
Constructors
AliasProviderBase(String)
Declaration
protected AliasProviderBase(string aliasedProviderName)
Parameters
Type |
Name |
Description |
String |
aliasedProviderName |
|
Properties
AliasedProvider
Declaration
protected AliasedType AliasedProvider { get; }
Property Value
Type |
Description |
AliasedType |
|
Methods
AddEntityOverride(String, String, String)
Declaration
protected void AddEntityOverride(string innerProviderEntity, string overrideName, string overrideDisplayName)
Parameters
Type |
Name |
Description |
String |
innerProviderEntity |
|
String |
overrideName |
|
String |
overrideDisplayName |
|
Close()
Declaration
public virtual void Close()
GetAvailableColumns()
Declaration
public virtual List<ArchiveColumnInfo> GetAvailableColumns()
Returns
GetAvailableEntities()
Declaration
public virtual List<ArchiveRowTypeInfo> GetAvailableEntities()
Returns
GetReader(String)
Start the provider, returning an IDataReader compatible object to the client for row enumeration and data access
Declaration
public virtual IDataReader GetReader(string options)
Parameters
Type |
Name |
Description |
String |
options |
Options, passed to the internal GetRows method
|
Returns
Type |
Description |
IDataReader |
IDataReader primed to provide results
|
Declaration
public ArchiveResultInformation GetResultInformation()
Returns
GetRows(String)
Declaration
public virtual IEnumerable<ArchiveRow> GetRows(string options)
Parameters
Type |
Name |
Description |
String |
options |
|
Returns
SetDesiredColumns(String[])
Declaration
public virtual void SetDesiredColumns(params string[] columnIds)
Parameters
Type |
Name |
Description |
String[] |
columnIds |
|
SetDesiredEntities(String[])
Declaration
public virtual void SetDesiredEntities(params string[] entities)
Parameters
Type |
Name |
Description |
String[] |
entities |
|
SetOrderBy(ArchiveOrderByInfo[])
Declaration
public virtual void SetOrderBy(params ArchiveOrderByInfo[] orderBy)
Parameters
SetPagingInfo(Int32, Int32)
Declaration
public virtual void SetPagingInfo(int pageSize, int pageNumber)
Parameters
Type |
Name |
Description |
Int32 |
pageSize |
|
Int32 |
pageNumber |
|
SetRestriction(ArchiveRestrictionInfo[])
Declaration
public virtual bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)
Parameters
Returns
Implements
Extension Methods
EnumUtil.MapEnums<From, To>(From)