Show / Hide Table of Contents

Class SuggestedDocumentExtenderBase

Extender base for suggested document items in Guides

Inheritance
object
ExtensibleColumnsBase
ExtenderBase<SuggestedDocumentTableInfo>
GuideExtenderBase<SuggestedDocumentTableInfo>
SuggestedDocumentExtenderBase
ProjectSuggestedDocumentExtender
SaleSuggestedDocumentExtender
Implements
IArchiveProviderQueryMapping
IArchiveExtender
IArchiveProviderDoesExtend
IArchiveProviderHasColumns
IArchiveProviderExtensible
Inherited Members
GuideExtenderBase<SuggestedDocumentTableInfo>.ColumnStageId
GuideExtenderBase<SuggestedDocumentTableInfo>.ColumnStageName
GuideExtenderBase<SuggestedDocumentTableInfo>.ColumnStageOrderBy
GuideExtenderBase<SuggestedDocumentTableInfo>.ColumnSuggestedItemId
GuideExtenderBase<SuggestedDocumentTableInfo>.ColumnSuggestedItemText
GuideExtenderBase<SuggestedDocumentTableInfo>.ColumnSuggestedItemOrderBy
GuideExtenderBase<SuggestedDocumentTableInfo>.ColumnSuggestedItemTooltip
GuideExtenderBase<SuggestedDocumentTableInfo>.ColumnHasInstance
GuideExtenderBase<SuggestedDocumentTableInfo>.ColumnInstanceItemId
GuideExtenderBase<SuggestedDocumentTableInfo>.ColumnInstanceItemText
GuideExtenderBase<SuggestedDocumentTableInfo>.ColumnDeleted
GuideExtenderBase<SuggestedDocumentTableInfo>._colCompleted
GuideExtenderBase<SuggestedDocumentTableInfo>._colDate
GuideExtenderBase<SuggestedDocumentTableInfo>._colText
GuideExtenderBase<SuggestedDocumentTableInfo>._colStageName
GuideExtenderBase<SuggestedDocumentTableInfo>._colStageId
GuideExtenderBase<SuggestedDocumentTableInfo>._colStageOrderBy
GuideExtenderBase<SuggestedDocumentTableInfo>._colSuggestedItemId
GuideExtenderBase<SuggestedDocumentTableInfo>._colSuggestedItemText
GuideExtenderBase<SuggestedDocumentTableInfo>._colSuggestedItemOrderBy
GuideExtenderBase<SuggestedDocumentTableInfo>._colSuggestedItemTooltip
GuideExtenderBase<SuggestedDocumentTableInfo>._colInstanceItemId
GuideExtenderBase<SuggestedDocumentTableInfo>._colInstanceItemText
GuideExtenderBase<SuggestedDocumentTableInfo>._colHasInstance
GuideExtenderBase<SuggestedDocumentTableInfo>._colDeleted
ExtenderBase<SuggestedDocumentTableInfo>.SetJoin()
ExtenderBase<SuggestedDocumentTableInfo>.GetRankRestriction(FieldInfo)
ExtenderBase<SuggestedDocumentTableInfo>.StyleHintPrefix
ExtensibleColumnsBase._minuteFields
ExtensibleColumnsBase.Visible
ExtensibleColumnsBase.Invisible
ExtensibleColumnsBase.AllowOrderBy
ExtensibleColumnsBase.DenyOrderBy
ExtensibleColumnsBase.GetAllRestriction
ExtensibleColumnsBase.GetNoneRestriction
ExtensibleColumnsBase.GetNameOrOverrideName(string)
ExtensibleColumnsBase.SetParent(IArchiveProviderExtensible)
ExtensibleColumnsBase.AddAvailableColumn(params ArchiveColumnInfo[])
ExtensibleColumnsBase.GetAvailableColumns()
ExtensibleColumnsBase.SetOrderBy(ArchiveOrderByInfo[])
ExtensibleColumnsBase.SetOrderByMapping(string, params string[])
ExtensibleColumnsBase.SetOrderByMapping(ArchiveColumnInfo, params ArchiveColumnInfo[])
ExtensibleColumnsBase.SetPrefixes(string, string)
ExtensibleColumnsBase.SetLocalAbsolutePrefixes(string, string)
ExtensibleColumnsBase.SetIconHint(string)
ExtensibleColumnsBase.SetRestriction(params ArchiveRestrictionInfo[])
ExtensibleColumnsBase.AddLocalRestriction(params ArchiveRestrictionInfo[])
ExtensibleColumnsBase.AddExtensionProvider(IArchiveExtender)
ExtensibleColumnsBase.GetExtensionProviders()
ExtensibleColumnsBase.GetTableInfosFromExtensionProviders()
ExtensibleColumnsBase.SuppressTableResults(SoDataReader, TableInfo)
ExtensibleColumnsBase.SuppressDeepTableResults(SoDataReader, TableInfo)
ExtensibleColumnsBase.AddColumnNameOverride(string, string)
ExtensibleColumnsBase.ApplyColumnNameOverridesToRestrictions()
ExtensibleColumnsBase.ApplyColumnNameOverrides(ArchiveRow)
ExtensibleColumnsBase.AddSubExtenderMapping(string, params ExtensibleColumnsBase[])
ExtensibleColumnsBase.WantColumnForOutput(params string[])
ExtensibleColumnsBase.WantColumnForOutput(params ArchiveColumnInfo[])
ExtensibleColumnsBase.WantColumnForOutput(List<ArchiveColumnInfo>)
ExtensibleColumnsBase.WantColumnForRestriction(params string[])
ExtensibleColumnsBase.WantColumnForRestriction(params ArchiveColumnInfo[])
ExtensibleColumnsBase.WantColumnForOrderBy(params string[])
ExtensibleColumnsBase.GetColumnOrderBy(string)
ExtensibleColumnsBase.WantColumnForOrderBy(params ArchiveColumnInfo[])
ExtensibleColumnsBase.WantColumnForAnything(params string[])
ExtensibleColumnsBase.WantColumnForAnything(params ArchiveColumnInfo[])
ExtensibleColumnsBase.IsQueryNeeded()
ExtensibleColumnsBase.IsQueryRestriction()
ExtensibleColumnsBase.GetLeftOuterOrInnerJoin(Equal)
ExtensibleColumnsBase.GetLeftOuterOrInnerJoin(Equal, Restriction)
ExtensibleColumnsBase.SetLeftOuterJoin(Equal)
ExtensibleColumnsBase.SetLeftOuterJoin(Equal, Restriction)
ExtensibleColumnsBase.SetLeftOuterOrInnerJoin(Equal)
ExtensibleColumnsBase.SetLeftOuterOrInnerJoin(Equal, Restriction)
ExtensibleColumnsBase.MapReturnField(ArchiveSelect, FieldInfo, bool, string, params ArchiveColumnInfo[])
ExtensibleColumnsBase.MapIdField(FieldInfo)
ExtensibleColumnsBase.MapAssociateField(FieldInfo, ArchiveColumnInfo, bool)
ExtensibleColumnsBase.MapEjUserField(FieldInfo, ArchiveColumnInfo)
ExtensibleColumnsBase.MapSimpleReturnField(FieldInfo, params ArchiveColumnInfo[])
ExtensibleColumnsBase.MapSimpleImageField(FieldInfo, ArchiveColumnInfo, int, int)
ExtensibleColumnsBase.MapPictureBlob(FieldInfo, ArchiveColumnInfo, BlobLinkType, int, int, int)
ExtensibleColumnsBase.MapSimpleCustomField(FieldInfo, params ArchiveColumnInfo[])
ExtensibleColumnsBase.MapSimpleListReturnField(FieldInfo, string, params ArchiveColumnInfo[])
ExtensibleColumnsBase.MapOrderByField(FieldInfo, ArchiveColumnInfo)
ExtensibleColumnsBase.ActivateAsLinkField(string, params ArchiveColumnInfo[])
ExtensibleColumnsBase.HasAvailableColumn(string)
ExtensibleColumnsBase.AddAndInitializeExtensionProvider<ExtenderType>(ExtenderType, string, string)
ExtensibleColumnsBase.AddAndInitializeExtensionProvider<ExtenderType>(ExtenderType)
ExtensibleColumnsBase.HasRestriction(string)
ExtensibleColumnsBase.ExtractRestrictions(string)
ExtensibleColumnsBase.ExtractRestrictions(ArchiveColumnInfo)
ExtensibleColumnsBase.ExtractRestriction(string)
ExtensibleColumnsBase.ExtractRestriction(ArchiveColumnInfo)
ExtensibleColumnsBase.ProcessOrderBy()
ExtensibleColumnsBase.PopulateSimpleFieldsAsync(SoDataReader, ArchiveRow, CancellationToken)
ExtensibleColumnsBase.CalculateOrderbyValue(string, SoDataReader, ArchiveColumnData)
ExtensibleColumnsBase.AddDbInfo(ArchiveColumnData, FieldInfo)
ExtensibleColumnsBase.AddDbInfo(ArchiveColumnData, int)
ExtensibleColumnsBase.ForceDisable()
ExtensibleColumnsBase.GetAssociateData(int)
ExtensibleColumnsBase.GetEjUserData(int)
ExtensibleColumnsBase.GetColumnIndex(ArchiveColumnInfo)
ExtensibleColumnsBase.GetColumnIndexFromReader(SoDataReader, FieldInfo, ref int)
ExtensibleColumnsBase.ConvertDbTypeToString(object, ExtensibleColumnsBase.DbColumnBinding)
ExtensibleColumnsBase.GetStandardTooltipHint(SoDataReader, FieldInfo)
ExtensibleColumnsBase.GetLinkHint(SoDataReader, string)
ExtensibleColumnsBase.SetNonZeroBoolRestriction(ArchiveColumnInfo)
ExtensibleColumnsBase.AddUpdatedByMapping(ArchiveColumnInfo, FieldInfo, FieldInfo)
ExtensibleColumnsBase.AddRegisteredMapping(ArchiveColumnInfo, FieldInfo, ArchiveColumnInfo, FieldInfo)
ExtensibleColumnsBase.AddLastUpdatedMapping(ArchiveColumnInfo, FieldInfo, FieldInfo)
ExtensibleColumnsBase.AddUpdatedBy(SoDataReader, ArchiveRow, ArchiveColumnInfo, FieldInfo, FieldInfo)
ExtensibleColumnsBase.AddUpdatedDate(SoDataReader, ArchiveRow, ArchiveColumnInfo, FieldInfo, FieldInfo, bool)
ExtensibleColumnsBase.AddAssociateFullName(SoDataReader, ArchiveRow, ArchiveColumnInfo, params FieldInfo[])
ExtensibleColumnsBase.GetIdFieldTag(SoDataReader)
ExtensibleColumnsBase.GetArchiveColumnName(SoField)
ExtensibleColumnsBase.ExtensibleHelper
ExtensibleColumnsBase.ColumnHelper
ExtensibleColumnsBase.RestrictionHelper
ExtensibleColumnsBase.Parent
ExtensibleColumnsBase.DisableSubtreeIfNoRestriction
ExtensibleColumnsBase.RestrictionSetForSubtree
ExtensibleColumnsBase.ForceQueryNeeded
ExtensibleColumnsBase.ForceRestriction
ExtensibleColumnsBase.BlockOrderBy
ExtensibleColumnsBase.IdField
ExtensibleColumnsBase.LastSubExtenderWins
ExtensibleColumnsBase.ParentPrimaryKey
ExtensibleColumnsBase.QuoteAlternativeId
ExtensibleColumnsBase.SaleId
ExtensibleColumnsBase.NamePrefix
ExtensibleColumnsBase.DisplayNamePrefix
ExtensibleColumnsBase.RootQuery
ExtensibleColumnsBase.OrderBySlots
ExtensibleColumnsBase.PopulateDisplayValue
ExtensibleColumnsBase.PopulateTooltipHint
ExtensibleColumnsBase.DebugXML
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
public abstract class SuggestedDocumentExtenderBase : GuideExtenderBase<SuggestedDocumentTableInfo>, IArchiveProviderQueryMapping, IArchiveExtender, IArchiveProviderDoesExtend, IArchiveProviderHasColumns, IArchiveProviderExtensible
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.

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
ExtenderBase<SuggestedDocumentTableInfo>.MainTableName
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
ExtensibleColumnsBase.TableToExtend
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
ExtenderBase<SuggestedDocumentTableInfo>.InnerModifyQuery()
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
ExtensibleColumnsBase.InnerPopulateRowFromReader(SoDataReader, ArchiveRow)
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
ExtenderBase<SuggestedDocumentTableInfo>.ModifyQuery()
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
ExtensibleColumnsBase.PopulateRowFromReaderAsync(SoDataReader, ArchiveRow, CancellationToken)
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
ExtensibleColumnsBase.ProcessRestrictions()
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
ExtensibleColumnsBase.SetDesiredColumns(params 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.

Implements

IArchiveProviderQueryMapping
IArchiveExtender
IArchiveProviderDoesExtend
IArchiveProviderHasColumns
IArchiveProviderExtensible

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top