Class SuggestedDocumentExtenderBase
Extender base for suggested document items in Guides
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
public abstract class SuggestedDocumentExtenderBase : GuideExtenderBase<SuggestedDocumentTableInfo>, IArchiveProviderQueryMapping, IArchiveExtender, IArchiveProviderDoesExtend, IArchiveProviderHasColumns, IArchiveProviderExtensibleRemarks
This extender specializes the generic base class into one that specifically handles documents, but does not take any stand on whether we're dealing with a Sale or Project guide as ultimate parent.
Constructors
SuggestedDocumentExtenderBase()
Extender base for suggested document items in Guides
Declaration
public SuggestedDocumentExtenderBase()Remarks
This extender specializes the generic base class into one that specifically handles documents, but does not take any stand on whether we're dealing with a Sale or Project guide as ultimate parent.
Fields
DocumentInstancePrefix
Extender base for suggested document items in Guides
Declaration
public const string DocumentInstancePrefix = "documentInstance"Field Value
| Type | Description |
|---|---|
| string |
Remarks
This extender specializes the generic base class into one that specifically handles documents, but does not take any stand on whether we're dealing with a Sale or Project guide as ultimate parent.
Properties
MainTableName
The name of the table that this node is the handler for
Declaration
public override string MainTableName { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
Remarks
This extender specializes the generic base class into one that specifically handles documents, but does not take any stand on whether we're dealing with a Sale or Project guide as ultimate parent.
TableToExtend
Return the table to extend, as defined by THIS extender class.
Declaration
public override TableInfo TableToExtend { get; }Property Value
| Type | Description |
|---|---|
| TableInfo |
Overrides
Remarks
This extender specializes the generic base class into one that specifically handles documents, but does not take any stand on whether we're dealing with a Sale or Project guide as ultimate parent.
Methods
HasInstance(SoDataReader)
Extender base for suggested document items in Guides
Declaration
public bool HasInstance(SoDataReader reader)Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader |
Returns
| Type | Description |
|---|---|
| bool |
Remarks
This extender specializes the generic base class into one that specifically handles documents, but does not take any stand on whether we're dealing with a Sale or Project guide as ultimate parent.
InnerModifyQuery()
Template method called from ModifyQuery() during query processing; subclasses should implement it to build their queries. It will ONLY be called if IsQueryNeeded returns true.
Declaration
protected override void InnerModifyQuery()Overrides
Remarks
This extender specializes the generic base class into one that specifically handles documents, but does not take any stand on whether we're dealing with a Sale or Project guide as ultimate parent.
InnerPopulateRowFromReader(SoDataReader, ArchiveRow)
Derived classes should implement the population of ColumnData items for columns that are NOT handled by this base class in this method. Whether a column is handled by this base class is part of its database binding information, set by the various MapXXX methods.
Declaration
protected override void InnerPopulateRowFromReader(SoDataReader reader, ArchiveRow row)Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | Data reader with the query result (one row) |
| ArchiveRow | row | archive row to be populated |
Overrides
Remarks
This extender specializes the generic base class into one that specifically handles documents, but does not take any stand on whether we're dealing with a Sale or Project guide as ultimate parent.
ModifyQuery()
Interface implementation, called from outer query provider to build the query
Declaration
public override void ModifyQuery()Overrides
Remarks
This extender specializes the generic base class into one that specifically handles documents, but does not take any stand on whether we're dealing with a Sale or Project guide as ultimate parent.
PopulateRowFromReaderAsync(SoDataReader, ArchiveRow, CancellationToken)
Extender base for suggested document items in Guides
Declaration
public override Task PopulateRowFromReaderAsync(SoDataReader reader, ArchiveRow row, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | |
| ArchiveRow | row | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task |
Overrides
Remarks
This extender specializes the generic base class into one that specifically handles documents, but does not take any stand on whether we're dealing with a Sale or Project guide as ultimate parent.
ProcessRestrictions()
Process restrictions during query processing. This is where the abstract syntax of the ArchiveRestrictionInfo objects is converted into Restriction clauses, and string-formatted parameters are converted into their proper form.
Declaration
protected override bool ProcessRestrictions()Returns
| Type | Description |
|---|---|
| bool | true if at least one of the currently set restrictions matched an available and bound column and was processed |
Overrides
Remarks
This extender specializes the generic base class into one that specifically handles documents, but does not take any stand on whether we're dealing with a Sale or Project guide as ultimate parent.
SetDesiredColumns(params string[])
Set the list of desired columns. This method sets the desired columns of this provider, as well as invoking the same call on all known extenders. Recursion will take it to the bottom. Any column name overrides are processed, i.e., replaced with the original inner names, so that the inner providers do not see the overrides.
Declaration
public override void SetDesiredColumns(params string[] columnIds)Parameters
| Type | Name | Description |
|---|---|---|
| string[] | columnIds | Array of programmatic column names |
Overrides
Remarks
This extender specializes the generic base class into one that specifically handles documents, but does not take any stand on whether we're dealing with a Sale or Project guide as ultimate parent.