Class AsyncProviderWrapper
Wrapper class to run Archive Providers asynchronously; read remarks on GetRows(String) for special processing information
Inheritance
AsyncProviderWrapper
Assembly: SoDataBase.dll
Syntax
public class AsyncProviderWrapper : IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities, IPlugin
Constructors
AsyncProviderWrapper(IArchiveProvider)
Declaration
public AsyncProviderWrapper(IArchiveProvider innerProvider)
Parameters
Methods
Close()
Close the archive provider; can be called at any time and will return immediately
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 |
String |
options |
Options, passed to the internal GetRows method
|
Returns
Type |
Description |
IDataReader |
IDataReader primed to provide results
|
Declaration
public ArchiveResultInformation GetResultInformation()
Returns
GetRows(String)
Get rows, asynchronously. This method may return null rows while waiting for "real" data; the client must handle this
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 |
|
SetDesiredEntities(String[])
Declaration
public void SetDesiredEntities(params string[] entities)
Parameters
Type |
Name |
Description |
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 |
Int32 |
pageSize |
|
Int32 |
pageNumber |
|
SetRestriction(ArchiveRestrictionInfo[])
Declaration
public bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)
Parameters
Returns
Implements
Extension Methods
EnumUtil.MapEnums<From, To>(From)