Class MappedPreferenceProvider

Get all the mapped ('fake') Service preferences known to the ServicePreferenceMapper. NOTE that only section and key are supported as restrictions, and only with the equals operator. Anything else needs to be coded!

Inheritance
object
InMemoryProviderBase<ArchiveRow>
MappedPreferenceProvider
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[ArchiveProvider("MappedPreferences", 1073741823)]
public class MappedPreferenceProvider : InMemoryProviderBase<ArchiveRow>, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities

Constructors

MappedPreferenceProvider()

Get all the mapped ('fake') Service preferences known to the ServicePreferenceMapper. NOTE that only section and key are supported as restrictions, and only with the equals operator. Anything else needs to be coded!

Declaration
public MappedPreferenceProvider()

Fields

ProviderName

Get all the mapped ('fake') Service preferences known to the ServicePreferenceMapper. NOTE that only section and key are supported as restrictions, and only with the equals operator. Anything else needs to be coded!

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

_colDeflevel

Get all the mapped ('fake') Service preferences known to the ServicePreferenceMapper. NOTE that only section and key are supported as restrictions, and only with the equals operator. Anything else needs to be coded!

Declaration
protected ArchiveColumnInfo _colDeflevel
Field Value
Type Description
ArchiveColumnInfo

_colDeflevelName

Get all the mapped ('fake') Service preferences known to the ServicePreferenceMapper. NOTE that only section and key are supported as restrictions, and only with the equals operator. Anything else needs to be coded!

Declaration
protected ArchiveColumnInfo _colDeflevelName
Field Value
Type Description
ArchiveColumnInfo

_colMaxlevel

Get all the mapped ('fake') Service preferences known to the ServicePreferenceMapper. NOTE that only section and key are supported as restrictions, and only with the equals operator. Anything else needs to be coded!

Declaration
protected ArchiveColumnInfo _colMaxlevel
Field Value
Type Description
ArchiveColumnInfo

_colMaxlevelName

Get all the mapped ('fake') Service preferences known to the ServicePreferenceMapper. NOTE that only section and key are supported as restrictions, and only with the equals operator. Anything else needs to be coded!

Declaration
protected ArchiveColumnInfo _colMaxlevelName
Field Value
Type Description
ArchiveColumnInfo

_colOwner

Get all the mapped ('fake') Service preferences known to the ServicePreferenceMapper. NOTE that only section and key are supported as restrictions, and only with the equals operator. Anything else needs to be coded!

Declaration
protected ArchiveColumnInfo _colOwner
Field Value
Type Description
ArchiveColumnInfo

_colOwnerId

Get all the mapped ('fake') Service preferences known to the ServicePreferenceMapper. NOTE that only section and key are supported as restrictions, and only with the equals operator. Anything else needs to be coded!

Declaration
protected ArchiveColumnInfo _colOwnerId
Field Value
Type Description
ArchiveColumnInfo

_colPrefkey

Get all the mapped ('fake') Service preferences known to the ServicePreferenceMapper. NOTE that only section and key are supported as restrictions, and only with the equals operator. Anything else needs to be coded!

Declaration
protected ArchiveColumnInfo _colPrefkey
Field Value
Type Description
ArchiveColumnInfo

_colPrefsection

Get all the mapped ('fake') Service preferences known to the ServicePreferenceMapper. NOTE that only section and key are supported as restrictions, and only with the equals operator. Anything else needs to be coded!

Declaration
protected ArchiveColumnInfo _colPrefsection
Field Value
Type Description
ArchiveColumnInfo

_colPrefvalue

Get all the mapped ('fake') Service preferences known to the ServicePreferenceMapper. NOTE that only section and key are supported as restrictions, and only with the equals operator. Anything else needs to be coded!

Declaration
protected ArchiveColumnInfo _colPrefvalue
Field Value
Type Description
ArchiveColumnInfo

_colUserPreferenceId

Get all the mapped ('fake') Service preferences known to the ServicePreferenceMapper. NOTE that only section and key are supported as restrictions, and only with the equals operator. Anything else needs to be coded!

Declaration
protected ArchiveColumnInfo _colUserPreferenceId
Field Value
Type Description
ArchiveColumnInfo

_colValue

Get all the mapped ('fake') Service preferences known to the ServicePreferenceMapper. NOTE that only section and key are supported as restrictions, and only with the equals operator. Anything else needs to be coded!

Declaration
protected ArchiveColumnInfo _colValue
Field Value
Type Description
ArchiveColumnInfo

Properties

BaseClassShouldFilterColumns

Subclass contract: Return true if the base class should filter columns according to SetDesiredColumns. If this property is false, the actual ArchiveRow objects are returned; otherwise a typed copy is made and ColumnData are populated accoprding to DesiredColumns.

Declaration
protected override bool BaseClassShouldFilterColumns { get; }
Property Value
Type Description
bool
Overrides
Remarks

If columns are cheap to get, the subclass can save code by leaving the filtering to this base class. Conversely, if somecolumns are expensive to calculate, the subclass should do the filtering itself to improve performance.

BaseClassShouldFilterEntities

Subclass contract: Return true if the base class should filter columns according to SetDesiredColumns. If this property is false, the actual ArchiveRow objects are returned; otherwise a typed copy is made and ColumnData are populated accoprding to DesiredColumns.

Declaration
protected override bool BaseClassShouldFilterEntities { get; }
Property Value
Type Description
bool
Overrides
Remarks

If columns are cheap to get, the subclass can save code by leaving the filtering to this base class. Conversely, if somecolumns are expensive to calculate, the subclass should do the filtering itself to improve performance.

BaseClassShouldPage

Subclass contract: Return true if the base class should perform filter entities according to SetDesiredEntities. If this property is false, the result set is assumed to represent the chosen entities only.

Declaration
protected override bool BaseClassShouldPage { get; }
Property Value
Type Description
bool
Overrides
Remarks

If rows are cheap to get, the subclass can save code by leaving the filtering to this base class. Conversely, if rows are expensive to calculate, the subclass should do the entity filtering itself to improve performance.

BaseClassShouldSort

Subclass contract: Return true if the base class should perform sorting according to SetOrderBy. If this property is false, the result set is assumed to be correctly ordered.

Declaration
protected override bool BaseClassShouldSort { get; }
Property Value
Type Description
bool
Overrides

Methods

GetResultDataAsync(CancellationToken)

Since we leave all the sort/filter/etc logic to the base class, we just deliver everything here

Declaration
protected override IAsyncEnumerable<ArchiveRow> GetResultDataAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
IAsyncEnumerable<ArchiveRow>
Overrides

SetRestriction(params ArchiveRestrictionInfo[])

Set query restriction globally, supersedes previous restrictions

Declaration
public override bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)
Parameters
Type Name Description
ArchiveRestrictionInfo[] restrictions

Array of restrictions, with an implicit AND between them
Returns
Type Description
bool

true if at least one of the restrictions matched one of the available columns of the provider
Overrides

Implements

Extension Methods