Class CombinedSelectionProviderBase

Implements the base functionality for selections of type Combined

Inheritance
object
CombinedSelectionProviderBase
AppointmentSelectionCombinedProvider
AppointmentSelectionCombinedProviderV2
AppointmentShadowSelectionCombinedProvider
AppointmentShadowSelectionCombinedProviderV2
ChatConversationSelectionCombinedProviderV2
ChatConversationShadowSelectionCombinedProviderV2
ContactPersonSelectionCombinedProviderV2
CustomObjectSelectionCombinedProviderV2
DocumentSelectionCombinedProvider
DocumentSelectionCombinedProviderV2
DocumentShadowSelectionCombinedProvider
DocumentShadowSelectionCombinedProviderV2
FormSubmissionSelectionCombinedProviderV2
FormSubmissionShadowSelectionCombinedProviderV2
MailingsSelectionCombinedProviderV2
MailingsShadowSelectionCombinedProviderV2
ProjectSelectionCombinedProvider
ProjectSelectionCombinedProviderV2
ProjectShadowSelectionCombinedProvider
ProjectShadowSelectionCombinedProviderV2
QuoteLineSelectionCombinedProvider
QuoteLineSelectionCombinedProviderV2
QuoteLineShadowSelectionCombinedProvider
QuoteLineShadowSelectionCombinedProviderV2
SaleSelectionCombinedProvider
SaleSelectionCombinedProviderV2
SaleShadowSelectionCombinedProvider
SaleShadowSelectionCombinedProviderV2
SelectionSelectionCombinedProviderV2
TicketSelectionCombinedProvider
TicketSelectionCombinedProviderV2
TicketShadowSelectionCombinedProvider
TicketShadowSelectionCombinedProviderV2
SelectionCombinedProvider
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists.Archive
Assembly: SoDataBase.BusinessLogic.dll
Syntax
public abstract class CombinedSelectionProviderBase : IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities

Constructors

CombinedSelectionProviderBase(bool, string)

Constructor for the combined selection provider

Declaration
public CombinedSelectionProviderBase(bool isShadow, string providerName)
Parameters
Type Name Description
bool isShadow

True/false to override if we should use the shadow sub-providers or not.
string providerName

Fields

ColCombineType

Implements the base functionality for selections of type Combined

Declaration
public const string ColCombineType = "combineType"
Field Value
Type Description
string

ColCompanyUnique

Implements the base functionality for selections of type Combined

Declaration
public const string ColCompanyUnique = "companyUnique"
Field Value
Type Description
string

ColIsShadow

Implements the base functionality for selections of type Combined

Declaration
public const string ColIsShadow = "isShadow"
Field Value
Type Description
string

ColLeftId

Implements the base functionality for selections of type Combined

Declaration
public const string ColLeftId = "leftId"
Field Value
Type Description
string

ColRightId

Implements the base functionality for selections of type Combined

Declaration
public const string ColRightId = "rightId"
Field Value
Type Description
string

ColSelectionId

Implements the base functionality for selections of type Combined

Declaration
public const string ColSelectionId = "selectionId"
Field Value
Type Description
string

ColTargetTableNumber

Implements the base functionality for selections of type Combined

Declaration
public const string ColTargetTableNumber = "targetTableNumber"
Field Value
Type Description
string

_combineType

Type of combination operation

Declaration
protected int _combineType
Field Value
Type Description
int

_entityType

Type of entity

Declaration
protected string _entityType
Field Value
Type Description
string

_isCompanyUnique

True/False depending on wether or not the companyUnique flag is set

Declaration
protected bool _isCompanyUnique
Field Value
Type Description
bool

_isShadow

True/False depending on wether or not we're to use shadow sub-providers or not.

Declaration
protected bool _isShadow
Field Value
Type Description
bool

_leftId

Identifier of the left sub-provider

Declaration
protected int _leftId
Field Value
Type Description
int

_leftProvider

Sub-provider on the left hand side of the combine operation

Declaration
protected IArchiveProvider _leftProvider
Field Value
Type Description
IArchiveProvider

_rightId

Identifier of the right sub-provider

Declaration
protected int _rightId
Field Value
Type Description
int

_rightProvider

Sub-provider on the right-hand side of the combination operation

Declaration
protected IArchiveProvider _rightProvider
Field Value
Type Description
IArchiveProvider

Properties

Combinator

Returns the Combinator for this selection

Declaration
protected Combinator Combinator { get; }
Property Value
Type Description
Combinator

EntityType

returns the entitytype for this provider

Declaration
public string EntityType { get; }
Property Value
Type Description
string

IsCompanyUnique

returns true if the companyUnique flag is set on the combined selection

Declaration
public bool IsCompanyUnique { get; }
Property Value
Type Description
bool

IsShadow

returns true if the provider is a shadow provider

Declaration
public bool IsShadow { get; }
Property Value
Type Description
bool

LeftProvider

Returns the left archive provider

Declaration
protected IArchiveProvider LeftProvider { get; }
Property Value
Type Description
IArchiveProvider

RightProvider

Returns the right provider

Declaration
protected IArchiveProvider RightProvider { get; }
Property Value
Type Description
IArchiveProvider

Methods

Close()

Closes the provider and the sub-providers

Declaration
public void Close()

GetAvailableColumns()

Returns a list of the available columns.

Declaration
public List<ArchiveColumnInfo> GetAvailableColumns()
Returns
Type Description
List<ArchiveColumnInfo>

GetAvailableEntities()

Returns the available entities (in the left sub-provider)

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

GetReaderAsync(string, CancellationToken)

Start the provider, returning an IDataReader compatible object to the client for row enumeration and data access

Declaration
public virtual Task<DbDataReader> GetReaderAsync(string options, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string options

Options, passed to the internal GetRows method
CancellationToken cancellationToken
Returns
Type Description
Task<DbDataReader>

IDataReader primed to provide results

GetResultInformationAsync()

Delegate the call to the combinator

Declaration
public Task<ArchiveResultInformation> GetResultInformationAsync()
Returns
Type Description
Task<ArchiveResultInformation>

GetRowsAsync(string, CancellationToken)

Returns the enumeration of archiverows from the provider.

Declaration
public IAsyncEnumerable<ArchiveRow> GetRowsAsync(string options, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string options
CancellationToken cancellationToken
Returns
Type Description
IAsyncEnumerable<ArchiveRow>

SetDesiredColumns(params string[])

Sets the desired columns

Declaration
public void SetDesiredColumns(params string[] columnIds)
Parameters
Type Name Description
string[] columnIds

array of columns to set

SetDesiredEntities(params string[])

Sets the desired entities in the left/right sub-provider

Declaration
public virtual void SetDesiredEntities(params string[] entities)
Parameters
Type Name Description
string[] entities

SetOrderBy(params ArchiveOrderByInfo[])

Set sort order in sub-providers and in the combinator.

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

SetPagingInfo(int, int)

Set paging information.

Declaration
public void SetPagingInfo(int pageSize, int pageNumber)
Parameters
Type Name Description
int pageSize
int pageNumber

SetRestriction(params ArchiveRestrictionInfo[])

Sets the restrictions for the provider.

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

Implements

Extension Methods