Show / Hide Table of Contents

Class QuoteConnectorProvider

Inheritance
object
InMemoryProviderBase<ArchiveRow>
QuoteConnectorProvider
Implements
IArchiveProvider
IArchiveProviderHasRows
IArchiveProviderHasColumns
IArchiveProviderHasEntities
Inherited Members
InMemoryProviderBase<ArchiveRow>._entityHelper
InMemoryProviderBase<ArchiveRow>.Visible
InMemoryProviderBase<ArchiveRow>.Invisible
InMemoryProviderBase<ArchiveRow>.AllowOrderBy
InMemoryProviderBase<ArchiveRow>.DenyOrderBy
InMemoryProviderBase<ArchiveRow>.Options
InMemoryProviderBase<ArchiveRow>.RegisterEntity(ArchiveRowTypeInfo)
InMemoryProviderBase<ArchiveRow>.GetReaderAsync(string, CancellationToken)
InMemoryProviderBase<ArchiveRow>.GetRowsAsync(string, CancellationToken)
InMemoryProviderBase<ArchiveRow>.GetResultInformationAsync()
InMemoryProviderBase<ArchiveRow>.SortData(List<ArchiveRow>)
InMemoryProviderBase<ArchiveRow>.Close()
InMemoryProviderBase<ArchiveRow>.SetPagingInfo(int, int)
InMemoryProviderBase<ArchiveRow>.GetAvailableColumns()
InMemoryProviderBase<ArchiveRow>.SetDesiredColumns(params string[])
InMemoryProviderBase<ArchiveRow>.SetOrderBy(params ArchiveOrderByInfo[])
InMemoryProviderBase<ArchiveRow>.GetAvailableEntities()
InMemoryProviderBase<ArchiveRow>.SetDesiredEntities(params string[])
InMemoryProviderBase<ArchiveRow>.EntityHelper
InMemoryProviderBase<ArchiveRow>.ColumnHelper
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[ArchiveProvider("QuoteConnector", 1073741823)]
public class QuoteConnectorProvider : InMemoryProviderBase<ArchiveRow>, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities

Fields

ColumnAssemblyName

Declaration
public const string ColumnAssemblyName = "assemblyName"
Field Value
Type Description
string

ColumnClassName

Declaration
public const string ColumnClassName = "className"
Field Value
Type Description
string

ColumnFilename

Declaration
public const string ColumnFilename = "filename"
Field Value
Type Description
string

ColumnLicensed

Declaration
public const string ColumnLicensed = "licensed"
Field Value
Type Description
string

ColumnLocation

Declaration
public const string ColumnLocation = "location"
Field Value
Type Description
string

ColumnName

Declaration
public const string ColumnName = "name"
Field Value
Type Description
string

ColumnVersion

Declaration
public const string ColumnVersion = "version"
Field Value
Type Description
string

ProviderName

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

RowTypeName

Declaration
public const string RowTypeName = "connector"
Field Value
Type Description
string

_colAssemblyName

Declaration
protected ArchiveColumnInfo _colAssemblyName
Field Value
Type Description
ArchiveColumnInfo

_colClassName

Declaration
protected ArchiveColumnInfo _colClassName
Field Value
Type Description
ArchiveColumnInfo

_colFilename

Declaration
protected ArchiveColumnInfo _colFilename
Field Value
Type Description
ArchiveColumnInfo

_colLicensed

Declaration
protected ArchiveColumnInfo _colLicensed
Field Value
Type Description
ArchiveColumnInfo

_colLocation

Declaration
protected ArchiveColumnInfo _colLocation
Field Value
Type Description
ArchiveColumnInfo

_colName

Declaration
protected ArchiveColumnInfo _colName
Field Value
Type Description
ArchiveColumnInfo

_colVersion

Declaration
protected ArchiveColumnInfo _colVersion
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
InMemoryProviderBase<ArchiveRow>.BaseClassShouldFilterColumns
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
InMemoryProviderBase<ArchiveRow>.BaseClassShouldFilterEntities
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
InMemoryProviderBase<ArchiveRow>.BaseClassShouldPage
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
InMemoryProviderBase<ArchiveRow>.BaseClassShouldSort

Methods

GetResultDataAsync(CancellationToken)

Subclass contract: Return a list of ArchiveRow items that are the current result

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

result list, which may be paged, sorted and column-filtered, or not, according to the abstract properties

Overrides
InMemoryProviderBase<ArchiveRow>.GetResultDataAsync(CancellationToken)

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
InMemoryProviderBase<ArchiveRow>.SetRestriction(params ArchiveRestrictionInfo[])

Implements

IArchiveProvider
IArchiveProviderHasRows
IArchiveProviderHasColumns
IArchiveProviderHasEntities

Extension Methods

IArchiverProviderHasRowsExtensions.GetRowsAsync(IArchiveProviderHasRows, CancellationToken)
EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top