Class CombinedSelectionProviderBase
Implements the base functionality for selections of type Combined
Inheritance
CombinedSelectionProviderBase
Assembly: SoDataBase.dll
Syntax
public abstract class CombinedSelectionProviderBase : IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities, IPlugin
Constructors
CombinedSelectionProviderBase(Boolean, String)
Constructor for the combined selection provider
Declaration
public CombinedSelectionProviderBase(bool isShadow, string providerName)
Parameters
| Type |
Name |
Description |
| Boolean |
isShadow |
True/false to override if we should use the shadow sub-providers or not.
|
| String |
providerName |
|
Fields
_combineType
Type of combination operation
Declaration
protected int _combineType
Field Value
_entityType
Declaration
protected string _entityType
Field Value
_isCompanyUnique
True/False depending on wether or not the companyUnique flag is set
Declaration
protected bool _isCompanyUnique
Field Value
_isShadow
True/False depending on wether or not we're to use shadow sub-providers or not.
Declaration
Field Value
_leftId
Identifier of the left sub-provider
Declaration
Field Value
_leftProvider
Sub-provider on the left hand side of the combine operation
Declaration
protected IArchiveProvider _leftProvider
Field Value
_rightId
Identifier of the right sub-provider
Declaration
Field Value
_rightProvider
Sub-provider on the right-hand side of the combination operation
Declaration
protected IArchiveProvider _rightProvider
Field Value
ColCombineType
Declaration
public const string ColCombineType = "combineType"
Field Value
ColCompanyUnique
Declaration
public const string ColCompanyUnique = "companyUnique"
Field Value
ColIsShadow
Declaration
public const string ColIsShadow = "isShadow"
Field Value
ColLeftId
Declaration
public const string ColLeftId = "leftId"
Field Value
ColRightId
Declaration
public const string ColRightId = "rightId"
Field Value
ColSelectionId
Declaration
public const string ColSelectionId = "selectionId"
Field Value
ColTargetTableNumber
Declaration
public const string ColTargetTableNumber = "targetTableNumber"
Field Value
Properties
Combinator
Returns the Combinator for this selection
Declaration
protected Combinator Combinator { get; }
Property Value
EntityType
returns the entitytype for this provider
Declaration
public string EntityType { get; }
Property Value
IsCompanyUnique
returns true if the companyUnique flag is set on the combined selection
Declaration
public bool IsCompanyUnique { get; }
Property Value
IsShadow
returns true if the provider is a shadow provider
Declaration
public bool IsShadow { get; }
Property Value
LeftProvider
Returns the left archive provider
Declaration
protected IArchiveProvider LeftProvider { get; }
Property Value
RightProvider
Returns the right provider
Declaration
protected IArchiveProvider RightProvider { get; }
Property Value
Methods
Close()
Closes the provider and the sub-providers
Declaration
GetAvailableColumns()
Returns a list of the available columns.
Declaration
public List<ArchiveColumnInfo> GetAvailableColumns()
Returns
GetAvailableEntities()
Returns the available entities (in the left sub-provider)
Declaration
public virtual List<ArchiveRowTypeInfo> GetAvailableEntities()
Returns
GetReader(String)
Start the provider, returning an IDataReader compatible object to the client for row enumeration and data access
Declaration
public virtual IDataReader GetReader(string options)
Parameters
| Type |
Name |
Description |
| String |
options |
Options, passed to the internal GetRows method
|
Returns
| Type |
Description |
| IDataReader |
IDataReader primed to provide results
|
Delegate the call to the combinator
Declaration
public ArchiveResultInformation GetResultInformation()
Returns
GetRows(String)
Returns the enumeration of archiverows from the provider.
Declaration
public IEnumerable<ArchiveRow> GetRows(string options)
Parameters
| Type |
Name |
Description |
| String |
options |
|
Returns
SetDesiredColumns(String[])
Declaration
public void SetDesiredColumns(params string[] columnIds)
Parameters
| Type |
Name |
Description |
| String[] |
columnIds |
array of columns to set
|
SetDesiredEntities(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(ArchiveOrderByInfo[])
Set sort order in sub-providers and in the combinator.
Declaration
public void SetOrderBy(params ArchiveOrderByInfo[] orderBy)
Parameters
SetPagingInfo(Int32, Int32)
Declaration
public void SetPagingInfo(int pageSize, int pageNumber)
Parameters
| Type |
Name |
Description |
| Int32 |
pageSize |
|
| Int32 |
pageNumber |
|
SetRestriction(ArchiveRestrictionInfo[])
Sets the restrictions for the provider.
Declaration
public bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)
Parameters
Returns
Implements
Extension Methods
EnumUtil.MapEnums<From, To>(From)