Class ShadowSelectionProvider
Universal shadow selection dispatcher: Retrieve the contactId and/or personId of all contact/person shadow members of any selection
Inheritance
System.Object
ShadowSelectionProvider
Assembly: SoDataBase.dll
Syntax
[ArchiveProvider("ShadowSelection", 1073741823)]
public class ShadowSelectionProvider : Object, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities, IPlugin
Remarks
Fields
Declaration
protected ArchiveColumnInfo _colContactId
Field Value
_colPersonId
Declaration
protected ArchiveColumnInfo _colPersonId
Field Value
_colSelectionId
Declaration
protected ArchiveColumnInfo _colSelectionId
Field Value
ProviderName
Declaration
public const string ProviderName = "ShadowSelection"
Field Value
Type |
Description |
System.String |
|
Methods
Close()
Declaration
GetAvailableColumns()
Declaration
public List<ArchiveColumnInfo> GetAvailableColumns()
Returns
GetAvailableEntities()
Declaration
public 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 |
System.String |
options |
Options, passed to the internal GetRows method
|
Returns
Type |
Description |
System.Data.IDataReader |
IDataReader primed to provide results
|
Declaration
public ArchiveResultInformation GetResultInformation()
Returns
GetRows(String)
The main function - set up inner provider, transform column names, filter and transform results
Declaration
public IEnumerable<ArchiveRow> GetRows(string options)
Parameters
Type |
Name |
Description |
System.String |
options |
|
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<ArchiveRow> |
|
GetSupportedOptions()
Declaration
public string[] GetSupportedOptions()
Returns
Type |
Description |
System.String[] |
|
SetDesiredColumns(String[])
Declaration
public void SetDesiredColumns(params string[] columnIds)
Parameters
Type |
Name |
Description |
System.String[] |
columnIds |
|
SetDesiredEntities(String[])
Declaration
public void SetDesiredEntities(params string[] entities)
Parameters
Type |
Name |
Description |
System.String[] |
entities |
|
SetOrderBy(ArchiveOrderByInfo[])
Declaration
public void SetOrderBy(params ArchiveOrderByInfo[] orderBy)
Parameters
SetPagingInfo(Int32, Int32)
Declaration
public void SetPagingInfo(int pageSize, int pageNumber)
Parameters
Type |
Name |
Description |
System.Int32 |
pageSize |
|
System.Int32 |
pageNumber |
|
SetRestriction(ArchiveRestrictionInfo[])
Declaration
public bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Implements
Extension Methods
EnumUtil.MapEnums<From, To>(From)