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
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
[ArchiveProvider("ShadowSelection", 1073741823)]
public class ShadowSelectionProvider : Object, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities, IPlugin
Remarks

This class abstracts the differences between the various selection kinds (contact, sale, ...) with regard to contact and person id. You can give any selectionId to this provider, and it will reply with a list of contact and person ids; either pulled from the actual selection (if it's a contact selection) or its shadow.

Only the two ID columns are available. The row type is fixed (contact or person), and the column names are also fixed.

Fields

_colContactId

Declaration
protected ArchiveColumnInfo _colContactId
Field Value
Type Description
ArchiveColumnInfo

_colPersonId

Declaration
protected ArchiveColumnInfo _colPersonId
Field Value
Type Description
ArchiveColumnInfo

_colSelectionId

Declaration
protected ArchiveColumnInfo _colSelectionId
Field Value
Type Description
ArchiveColumnInfo

ProviderName

Declaration
public const string ProviderName = "ShadowSelection"
Field Value
Type Description
System.String

Methods

Close()

Declaration
public void Close()

GetAvailableColumns()

Declaration
public List<ArchiveColumnInfo> GetAvailableColumns()
Returns
Type Description
System.Collections.Generic.List<ArchiveColumnInfo>

GetAvailableEntities()

Declaration
public List<ArchiveRowTypeInfo> GetAvailableEntities()
Returns
Type Description
System.Collections.Generic.List<ArchiveRowTypeInfo>

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

GetResultInformation()

Declaration
public ArchiveResultInformation GetResultInformation()
Returns
Type Description
ArchiveResultInformation

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
Type Name Description
ArchiveOrderByInfo[] orderBy

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
Type Name Description
ArchiveRestrictionInfo[] restrictions
Returns
Type Description
System.Boolean

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)