Interface IArchiveProviderHasRows
This interface defines the property of having rows of an archive provider. It is implemented by the
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
public interface IArchiveProviderHasRowsMethods
Close()
Call this method after the last desired row has been read; this gives the provider the chance to close and free any underlying queries
Declaration
void Close()GetReader(String)
Start the reader and return an IDataReader (which, as we remember, also inherits IDataRecord for access to individual data fields). This provides an alternative, more generic and more standards-based interface to data. Use either GetRows or GetReader on any particular archive provider instance.
Declaration
IDataReader GetReader(string options)Parameters
| Type | Name | Description |
|---|---|---|
| String | options |
Returns
| Type | Description |
|---|---|
| IDataReader |
GetResultInformation()
Get additional information about the result, such as row count or other optional items. This method should be called some time after GetRows, but before Close. Delaying calls to this method as long as possible will give its (asynchronous) internal counterpart more time to complete and lessen the response-time impact of calling it.
Declaration
ArchiveResultInformation GetResultInformation()Returns
| Type | Description |
|---|---|
| ArchiveResultInformation |
GetRows(String)
Start the query and return an iterator. The .Current property will be a valid ArchiveRow containing one row, as long as a previous call to .MoveNext returned true. This is the standard semantics for an iterator. Do remember to call Close afterwards, to clean up all resources.
Declaration
IEnumerable<ArchiveRow> GetRows(string options)Parameters
| Type | Name | Description | ||||
|---|---|---|---|---|---|---|
| String | options | A set of options, using the query string format (name=value&...). Can be null or empty.
|
Returns
| Type | Description |
|---|---|
| IEnumerable<ArchiveRow> | An iterator, following the usual conventions. MoveNext will return false when there are no more rows, which can either be because the result set is exhausted, or because the page size has been reached |
Remarks
You can use the foreach keyword to iterate over rows, like this:
IArchiveProvider provider = ArchiveProviderFactory.Create("person");
// not shown - set desired columns, entities, restrictions, paging
foreach( ArchiveRow row in provider.GetRows() )
{
// process row here
}
provider.Close();SetPagingInfo(Int32, Int32)
Set the paging properties of the provider. The default is to fetch page zero, of one thousand (1000) rows. A more reasonable page size is probably around 100. Note that the query processing strategy may change for very large pages (more than 1000) and give significantly longer response times. Performance is improved by setting the page size low, as long as you don't set it lower than what you realistically expect to need (fetching multiple pages is more expensive than fetching one).
Declaration
void SetPagingInfo(int pageSize, int pageNumber)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | pageSize | Desired page size |
| Int32 | pageNumber | Desired page number to return |