Class TimeZonesProvider

Inheritance
object
ExtensibleColumnsBase
QueryProviderBase<ArchiveRow>
TimeZonesProvider
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[ArchiveProvider("TimeZones", 1073741823)]
public class TimeZonesProvider : QueryProviderBase<ArchiveRow>, IArchiveProviderQueryMapping, IArchiveQueryProvider, IArchiveProviderExtensible, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities

Constructors

TimeZonesProvider()

Declaration
protected TimeZonesProvider()

Fields

ProviderName

Declaration
public const string ProviderName = "TimeZones"
Field Value
Type Description
string

_colCities

Declaration
protected ArchiveColumnInfo _colCities
Field Value
Type Description
ArchiveColumnInfo

_colCountry

Declaration
protected ArchiveColumnInfo _colCountry
Field Value
Type Description
ArchiveColumnInfo

_colDaylight

Declaration
protected ArchiveColumnInfo _colDaylight
Field Value
Type Description
ArchiveColumnInfo

_colDaylightRaw

Declaration
protected ArchiveColumnInfo _colDaylightRaw
Field Value
Type Description
ArchiveColumnInfo

_colFlag

Declaration
protected ArchiveColumnInfo _colFlag
Field Value
Type Description
ArchiveColumnInfo

_colId

Declaration
protected ArchiveColumnInfo _colId
Field Value
Type Description
ArchiveColumnInfo

_colIsActive

Declaration
protected ArchiveColumnInfo _colIsActive
Field Value
Type Description
ArchiveColumnInfo

_colOffset

Declaration
protected ArchiveColumnInfo _colOffset
Field Value
Type Description
ArchiveColumnInfo

_colOffsetRaw

Declaration
protected ArchiveColumnInfo _colOffsetRaw
Field Value
Type Description
ArchiveColumnInfo

_colRegion

Declaration
protected ArchiveColumnInfo _colRegion
Field Value
Type Description
ArchiveColumnInfo

_colTimeZone

Declaration
protected ArchiveColumnInfo _colTimeZone
Field Value
Type Description
ArchiveColumnInfo

Properties

PrimaryTable

The primary table of this archive provider, from the derived class

Declaration
public override TableInfo PrimaryTable { get; }
Property Value
Type Description
TableInfo
Overrides

Query

The main query of this archive provider, from the derived class

Declaration
public override ArchiveSelect Query { get; }
Property Value
Type Description
ArchiveSelect
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
Type Description
List<IArchiveExtender>
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
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task
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

ProcessOrderBy()

Process order by information during query modification. For each order by column that matches a known database binding, add the orderby clause to the query. If the column has a separate fieldinfo specified for its orderby (as specified by MapOrderByField(FieldInfo, ArchiveColumnInfo), this field is used, otherwise the display field is used).

Declaration
protected override void ProcessOrderBy()
Overrides

SetOrderBy(ArchiveOrderByInfo[])

Set the order by parameters. This method sets the order by parameters of this provider, as well as invoking the same call on all known extenders. Recursion will take it to the bottom. This method actually only saves the orderby specification for use during query processing. Any column name overrides are processed, i.e., replaced with the original inner names, so that the inner providers do not see the overrides.

Declaration
public override void SetOrderBy(ArchiveOrderByInfo[] orderBy)
Parameters
Type Name Description
ArchiveOrderByInfo[] orderBy

Array of order by criteria
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
Type Name Description
ArchiveRestrictionInfo[] restrictions
Returns
Type Description
bool
Overrides

Implements

Extension Methods