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
Object
AliasProviderBase<AliasedType>
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
public abstract class AliasProviderBase<AliasedType> : IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities, IPlugin where AliasedType : IArchiveProvider
Type Parameters
Name Description
AliasedType
Remarks

This mechanism is useful if the same provider is used together with criteria storage in multiple contexts, and we want to keep the stored criteria separate for each context. In that case, we define a new provider as an alias, provide mappings for it in criterionmapping.config, and happily use it.

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
Type Description
List<ArchiveColumnInfo>

GetAvailableEntities()

Declaration
public virtual List<ArchiveRowTypeInfo> GetAvailableEntities()
Returns
Type Description
List<ArchiveRowTypeInfo>

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

GetResultInformation()

Declaration
public ArchiveResultInformation GetResultInformation()
Returns
Type Description
ArchiveResultInformation

GetRows(String)

Declaration
public virtual IEnumerable<ArchiveRow> GetRows(string options)
Parameters
Type Name Description
String options
Returns
Type Description
IEnumerable<ArchiveRow>

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
Type Name Description
ArchiveOrderByInfo[] orderBy

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
Type Name Description
ArchiveRestrictionInfo[] restrictions
Returns
Type Description
Boolean

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)