Show / Hide Table of Contents

Class TargetValueExtenderBase

Base extender class that handles target values. Can give you a stream of target values with associate and period/year, based on given criteria.

Inheritance
object
ExtensibleColumnsBase
ExtenderBaseTargetAssignmentValueTableInfo
TableExtenderBaseTargetAssignmentValueTableInfo
TargetValueExtenderBase
TargetValueTargetValueExtender
Implements
IArchiveProviderQueryMapping
IArchiveExtender
IArchiveProviderDoesExtend
IArchiveProviderHasColumns
IArchiveProviderExtensible
Inherited Members
TableExtenderBase<TargetAssignmentValueTableInfo>._ourTable
TableExtenderBase<TargetAssignmentValueTableInfo>.ModifyQuery()
TableExtenderBase<TargetAssignmentValueTableInfo>.TableToExtend
TableExtenderBase<TargetAssignmentValueTableInfo>.MainTableName
ExtenderBase<TargetAssignmentValueTableInfo>.SetJoin()
ExtenderBase<TargetAssignmentValueTableInfo>.GetRankRestriction(FieldInfo)
ExtenderBase<TargetAssignmentValueTableInfo>.StyleHintPrefix
ExtensibleColumnsBase._orderBy
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.SetDesiredColumns(params string[])
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.PopulateRowFromReaderAsync(SoDataReader, ArchiveRow, CancellationToken)
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.ProcessRestrictions()
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: SuperOfficeCRMArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
public abstract class TargetValueExtenderBase : TableExtenderBase<TargetAssignmentValueTableInfo>, IArchiveProviderQueryMapping, IArchiveExtender, IArchiveProviderDoesExtend, IArchiveProviderHasColumns, IArchiveProviderExtensible

Constructors

TargetValueExtenderBase()

Constructor

Declaration
protected TargetValueExtenderBase()

Fields

TargetAssignmentIdColName

Declaration
public const string TargetAssignmentIdColName = "targetAssignmentId"
Field Value
Type Description
string

TargetPeriodColName

Declaration
public const string TargetPeriodColName = "targetPeriod"
Field Value
Type Description
string

TargetPeriodNumberColName

Declaration
public const string TargetPeriodNumberColName = "targetPeriodNumber"
Field Value
Type Description
string

TargetPeriodTypeColName

Declaration
public const string TargetPeriodTypeColName = "targetPeriodType"
Field Value
Type Description
string

TargetValueColName

Declaration
public const string TargetValueColName = "targetValue"
Field Value
Type Description
string

_colTargetAssignmentDimensionItemId

Declaration
protected ArchiveColumnInfo _colTargetAssignmentDimensionItemId
Field Value
Type Description
ArchiveColumnInfo

_colTargetAssignmentId

Declaration
protected ArchiveColumnInfo _colTargetAssignmentId
Field Value
Type Description
ArchiveColumnInfo

_colTargetAssociate

Declaration
protected ArchiveColumnInfo _colTargetAssociate
Field Value
Type Description
ArchiveColumnInfo

_colTargetContactId

Declaration
protected ArchiveColumnInfo _colTargetContactId
Field Value
Type Description
ArchiveColumnInfo

_colTargetCurrency

Declaration
protected ArchiveColumnInfo _colTargetCurrency
Field Value
Type Description
ArchiveColumnInfo

_colTargetDimensionEntityType

Declaration
protected ArchiveColumnInfo _colTargetDimensionEntityType
Field Value
Type Description
ArchiveColumnInfo

_colTargetDimensionListField

Declaration
protected ArchiveColumnInfo _colTargetDimensionListField
Field Value
Type Description
ArchiveColumnInfo

_colTargetDimensionMeasurementUnit

Declaration
protected ArchiveColumnInfo _colTargetDimensionMeasurementUnit
Field Value
Type Description
ArchiveColumnInfo

_colTargetDimensionTargetTypeName

Declaration
protected ArchiveColumnInfo _colTargetDimensionTargetTypeName
Field Value
Type Description
ArchiveColumnInfo

_colTargetPeriod

Declaration
protected ArchiveColumnInfo _colTargetPeriod
Field Value
Type Description
ArchiveColumnInfo

_colTargetPeriodNumber

Declaration
protected ArchiveColumnInfo _colTargetPeriodNumber
Field Value
Type Description
ArchiveColumnInfo

_colTargetPeriodType

Declaration
protected ArchiveColumnInfo _colTargetPeriodType
Field Value
Type Description
ArchiveColumnInfo

_colTargetUserGroup

Declaration
protected ArchiveColumnInfo _colTargetUserGroup
Field Value
Type Description
ArchiveColumnInfo

_colTargetValue

Declaration
protected ArchiveColumnInfo _colTargetValue
Field Value
Type Description
ArchiveColumnInfo

_colTargetYear

Declaration
protected ArchiveColumnInfo _colTargetYear
Field Value
Type Description
ArchiveColumnInfo

_targetAssignmentInfoTable

Declaration
protected TargetAssignmentInfoTableInfo _targetAssignmentInfoTable
Field Value
Type Description
TargetAssignmentInfoTableInfo

_targetDimensionTable

Declaration
protected TargetDimensionTableInfo _targetDimensionTable
Field Value
Type Description
TargetDimensionTableInfo

_targetEntityTypeLookup

Declaration
protected Dictionary<string, ISoListItem> _targetEntityTypeLookup
Field Value
Type Description
DictionarystringISoListItem

_targetGroupTable

Declaration
protected TargetGroupTableInfo _targetGroupTable
Field Value
Type Description
TargetGroupTableInfo

_targetPeriodTable

Declaration
protected TargetPeriodTableInfo _targetPeriodTable
Field Value
Type Description
TargetPeriodTableInfo

Properties

EndDate

Declaration
public DateTime EndDate { get; }
Property Value
Type Description
DateTime

StartDate

Declaration
public DateTime StartDate { get; }
Property Value
Type Description
DateTime

Methods

InnerModifyQuery()

Add/map return fields to the query

Declaration
protected override void InnerModifyQuery()
Overrides
ExtenderBase<TargetAssignmentValueTableInfo>.InnerModifyQuery()

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
TableExtenderBase<TargetAssignmentValueTableInfo>.InnerPopulateRowFromReader(SoDataReader, ArchiveRow)

ProcessOrderBy()

Process order by information during query modification. For each order by column that matches a known database binding, add the orderby clause to the query. If the column has a separate fieldinfo specified for its orderby (as specified by MapOrderByField(FieldInfo, ArchiveColumnInfo), this field is used, otherwise the display field is used).

Declaration
protected override void ProcessOrderBy()
Overrides
ExtensibleColumnsBase.ProcessOrderBy()

SetOrderBy(ArchiveOrderByInfo[])

Set the order by parameters. This method sets the order by parameters of this provider, as well as invoking the same call on all known extenders. Recursion will take it to the bottom. This method actually only saves the orderby specification for use during query processing. 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 SetOrderBy(ArchiveOrderByInfo[] orderBy)
Parameters
Type Name Description
ArchiveOrderByInfo orderBy

Array of order by criteria

Overrides
ExtensibleColumnsBase.SetOrderBy(ArchiveOrderByInfo[])

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