Class CustomObjectProviderBase
Inheritance
CustomObjectProviderBase
Assembly: SoDataBase.BusinessLogic.dll
Syntax
public abstract class CustomObjectProviderBase : QueryProviderBase<ArchiveRow>, IArchiveProviderQueryMapping, IArchiveQueryProvider, IArchiveProviderExtensible, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities
Constructors
CustomObjectProviderBase(string)
Declaration
protected CustomObjectProviderBase(string tableName)
Parameters
| Type |
Name |
Description |
| string |
tableName |
|
Properties
PrimaryTable
The primary table of this archive provider, from the derived class
Declaration
public override TableInfo PrimaryTable { get; }
Property Value
Overrides
Query
The main query of this archive provider, from the derived class
Declaration
public override ArchiveSelect Query { get; }
Property Value
Overrides
RootExtenders
Implement this property to return the extender(s) that form the root of the query tree, or null if that
is not meaningful. This property is used by the dynamic column processing, which will fail and throw
an exception if null is returned here (no problem if dynamic column syntax is not used)
Declaration
protected override List<IArchiveExtender> RootExtenders { get; }
Property Value
Overrides
Methods
InnerMapFieldsAsync(CancellationToken)
Override this method to map query fields to columns, add additional return fields to the query, and set up custom restriction handling
Declaration
public override Task InnerMapFieldsAsync(CancellationToken cancellationToken = default)
Parameters
Returns
Overrides
InnerPopulateRowFromReader(SoDataReader, ArchiveRow)
Derived classes should implement the population of ColumnData items for columns
that are NOT handled by this base class in this method. Whether a column is handled by
this base class is part of its database binding information, set by the various MapXXX methods.
Declaration
protected override void InnerPopulateRowFromReader(SoDataReader reader, ArchiveRow row)
Parameters
| Type |
Name |
Description |
| SoDataReader |
reader |
Data reader with the query result (one row)
|
| ArchiveRow |
row |
archive row to be populated
|
Overrides
SetRestriction(params ArchiveRestrictionInfo[])
Set the restriction by calling the base class and InnerSetRestriction; take this opportunity to note
that a restriction has actually been set, so we can report cases of totally missing restrictions
(which is not acceptable as it might end up fetching the whole database)
Declaration
public override bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)
Parameters
Returns
Overrides
Implements
Extension Methods