Class SaintRestrictionExtenderBase
Base class for handling Saint restrictions - not column display (as yet anyway)
Inheritance
SaintRestrictionExtenderBase
Assembly: SoDataBase.dll
Syntax
public abstract class SaintRestrictionExtenderBase : ExtenderBase<CounterValueTableInfo>, IArchiveProviderQueryMapping, IArchiveExtender, IArchiveProviderDoesExtend, IArchiveProviderHasColumns, IArchiveProviderExtensible, IPlugin
Constructors
SaintRestrictionExtenderBase(SaintTarget, String)
Declaration
public SaintRestrictionExtenderBase(SaintTarget target, string iconHint)
Parameters
Fields
_colLastActivity
Declaration
protected ArchiveColumnInfo _colLastActivity
Field Value
_colLastCompletedActivity
Declaration
protected ArchiveColumnInfo _colLastCompletedActivity
Field Value
_colLastCompletedSale
Declaration
protected ArchiveColumnInfo _colLastCompletedSale
Field Value
_colLastCompletedTicket
Declaration
protected ArchiveColumnInfo _colLastCompletedTicket
Field Value
_colLastDoByActivity
Declaration
protected ArchiveColumnInfo _colLastDoByActivity
Field Value
_colLastDoBySale
Declaration
protected ArchiveColumnInfo _colLastDoBySale
Field Value
_colLastDoByTicket
Declaration
protected ArchiveColumnInfo _colLastDoByTicket
Field Value
_colLastSale
Declaration
protected ArchiveColumnInfo _colLastSale
Field Value
_colLastTicket
Declaration
protected ArchiveColumnInfo _colLastTicket
Field Value
_colNumberOfActivities
Declaration
protected ArchiveColumnInfo _colNumberOfActivities
Field Value
_colNumberOfActivitiesInPeriod
Declaration
protected ArchiveColumnInfo _colNumberOfActivitiesInPeriod
Field Value
_colNumberOfActivitiesInPeriod2
Declaration
protected ArchiveColumnInfo _colNumberOfActivitiesInPeriod2
Field Value
_colNumberOfActivitiesInPeriod3
Declaration
protected ArchiveColumnInfo _colNumberOfActivitiesInPeriod3
Field Value
_colNumberOfNotCompletedActivities
Declaration
protected ArchiveColumnInfo _colNumberOfNotCompletedActivities
Field Value
_colNumberOfNotCompletedActivitiesInPeriod
Declaration
protected ArchiveColumnInfo _colNumberOfNotCompletedActivitiesInPeriod
Field Value
_colNumberOfNotCompletedActivitiesInPeriod2
Declaration
protected ArchiveColumnInfo _colNumberOfNotCompletedActivitiesInPeriod2
Field Value
_colNumberOfNotCompletedActivitiesInPeriod3
Declaration
protected ArchiveColumnInfo _colNumberOfNotCompletedActivitiesInPeriod3
Field Value
_colNumberOfNotCompletedSales
Declaration
protected ArchiveColumnInfo _colNumberOfNotCompletedSales
Field Value
_colNumberOfNotCompletedSalesInPeriod
Declaration
protected ArchiveColumnInfo _colNumberOfNotCompletedSalesInPeriod
Field Value
_colNumberOfNotCompletedSalesInPeriod2
Declaration
protected ArchiveColumnInfo _colNumberOfNotCompletedSalesInPeriod2
Field Value
_colNumberOfNotCompletedSalesInPeriod3
Declaration
protected ArchiveColumnInfo _colNumberOfNotCompletedSalesInPeriod3
Field Value
_colNumberOfNotCompletedTickets
Declaration
protected ArchiveColumnInfo _colNumberOfNotCompletedTickets
Field Value
_colNumberOfNotCompletedTicketsInPeriod
Declaration
protected ArchiveColumnInfo _colNumberOfNotCompletedTicketsInPeriod
Field Value
_colNumberOfNotCompletedTicketsInPeriod2
Declaration
protected ArchiveColumnInfo _colNumberOfNotCompletedTicketsInPeriod2
Field Value
_colNumberOfNotCompletedTicketsInPeriod3
Declaration
protected ArchiveColumnInfo _colNumberOfNotCompletedTicketsInPeriod3
Field Value
_colNumberOfSales
Declaration
protected ArchiveColumnInfo _colNumberOfSales
Field Value
_colNumberOfSalesInPeriod
Declaration
protected ArchiveColumnInfo _colNumberOfSalesInPeriod
Field Value
_colNumberOfSalesInPeriod2
Declaration
protected ArchiveColumnInfo _colNumberOfSalesInPeriod2
Field Value
_colNumberOfSalesInPeriod3
Declaration
protected ArchiveColumnInfo _colNumberOfSalesInPeriod3
Field Value
_colNumberOfTickets
Declaration
protected ArchiveColumnInfo _colNumberOfTickets
Field Value
_colNumberOfTicketsInPeriod
Declaration
protected ArchiveColumnInfo _colNumberOfTicketsInPeriod
Field Value
_colNumberOfTicketsInPeriod2
Declaration
protected ArchiveColumnInfo _colNumberOfTicketsInPeriod2
Field Value
_colNumberOfTicketsInPeriod3
Declaration
protected ArchiveColumnInfo _colNumberOfTicketsInPeriod3
Field Value
_scolActivityType
Declaration
[AllowedMultitenantStatic]
protected static ArchiveColumnInfo _scolActivityType
Field Value
_scolAmountClass
Declaration
[AllowedMultitenantStatic]
protected static ArchiveColumnInfo _scolAmountClass
Field Value
_scolDirection
Declaration
[AllowedMultitenantStatic]
protected static ArchiveColumnInfo _scolDirection
Field Value
_scolIntention
Declaration
[AllowedMultitenantStatic]
protected static ArchiveColumnInfo _scolIntention
Field Value
_scolSaleStatus
Declaration
[AllowedMultitenantStatic]
protected static ArchiveColumnInfo _scolSaleStatus
Field Value
_scolTicketCategory
Declaration
[AllowedMultitenantStatic]
protected static ArchiveColumnInfo _scolTicketCategory
Field Value
_scolTicketStatus
Declaration
[AllowedMultitenantStatic]
protected static ArchiveColumnInfo _scolTicketStatus
Field Value
CounterMask
Bitmask used for criteria storage for counters
Declaration
public const int CounterMask = 8388608
Field Value
SaintActivityType
Declaration
public const string SaintActivityType = "saintActivityType"
Field Value
SaintAllChoice
Declaration
public const string SaintAllChoice = "-1"
Field Value
SaintAmountClass
Declaration
public const string SaintAmountClass = "saintAmountClass"
Field Value
SaintDirection
Declaration
public const string SaintDirection = "saintDirection"
Field Value
SaintIntention
Declaration
public const string SaintIntention = "saintIntention"
Field Value
SaintSaleStatus
Declaration
public const string SaintSaleStatus = "saintSaleStatus"
Field Value
SaintTicketCategory
Declaration
public const string SaintTicketCategory = "saintTicketCategory"
Field Value
SaintTicketStatus
Declaration
public const string SaintTicketStatus = "saintTicketStatus"
Field Value
StatusId
Declaration
public const string StatusId = "statusId"
Field Value
StatusMask
Bitmask used for criteria storage for statuses
Declaration
public const int StatusMask = 8912896
Field Value
Properties
MainTableName
Declaration
public override string MainTableName { get; }
Property Value
Overrides
SuperOffice.CRM.ArchiveLists.ExtenderBase<SuperOffice.CRM.Data.CounterValueTableInfo>.MainTableName
TableToExtend
Declaration
public override TableInfo TableToExtend { get; }
Property Value
Overrides
Methods
AddStatusDefCheck(Select, StatusValueTableInfo)
Add an additional join to the status monitor query, to exclude rows referring to status monitors
that are either deleted or in the needsUpdate (dirty) state
Declaration
protected void AddStatusDefCheck(Select query, StatusValueTableInfo statusValueTable)
Parameters
ConvertAllChoiceToDbValue(ArchiveRestrictionInfo, Int32)
The values that are used by the Saint system to denote the 'all' choice for various subrestrictions are not constant...
But in netServer we try to hide that, and say -1. Here, we convert that -1 value to whatever is the appropriate database value.
Declaration
public static ArchiveRestrictionInfo ConvertAllChoiceToDbValue(ArchiveRestrictionInfo subRestriction, int allChoiceDbValue)
Parameters
Type |
Name |
Description |
ArchiveRestrictionInfo |
subRestriction |
Subrestriction to check
|
Int32 |
allChoiceDbValue |
Actual value to use for the 'all' choice
|
Returns
ConvertDbValueToAllChoice(ArchiveRestrictionInfo, Int32)
The values that are used by the Saint system to denote the 'all' choice for various subrestrictions are not constant...
But in netServer we try to hide that, and say -1. Here, we convert that -1 value to whatever is the appropriate.
Declaration
public static ArchiveRestrictionInfo ConvertDbValueToAllChoice(ArchiveRestrictionInfo subRestriction, int allChoiceDbValue)
Parameters
Type |
Name |
Description |
ArchiveRestrictionInfo |
subRestriction |
Subrestriction to check
|
Int32 |
allChoiceDbValue |
Actual value to use for the 'all' choice
|
Returns
GetStatusIdFromStatusColumn(String)
Parse the name of a statusmonitor column to retrieve the ID
Declaration
public static int GetStatusIdFromStatusColumn(string columnName)
Parameters
Type |
Name |
Description |
String |
columnName |
|
Returns
GetSubRestrictionColumnInfo(String)
Get archive column info for a subrestriction
Declaration
public static ArchiveColumnInfo GetSubRestrictionColumnInfo(string columnName)
Parameters
Type |
Name |
Description |
String |
columnName |
Name of subrestriction column
|
Returns
Type |
Description |
ArchiveColumnInfo |
Information object for column, or null if this was not a valid subrestriction
|
GetSubRestrictionNames(String)
Get the names of the subrestrictions that belong to a particular saint column
Declaration
public static string[] GetSubRestrictionNames(string columnName)
Parameters
Type |
Name |
Description |
String |
columnName |
Saint column name
|
Returns
Type |
Description |
String[] |
Array of subrestriction names, null if the column was not a saint column or had no subrestrictions
|
InnerModifyQuery()
Set up custom binding for each outer-level restriction (column)
Declaration
protected override void InnerModifyQuery()
Overrides
SuperOffice.CRM.ArchiveLists.ExtenderBase<SuperOffice.CRM.Data.CounterValueTableInfo>.InnerModifyQuery()
InnerPopulateRowFromReader(SoDataReader, ArchiveRow)
There is no population with values... could possibly have populated those that are used as restrictions, but
it would take a little figuring to correctly map rows to subrestrictions
Declaration
protected override void InnerPopulateRowFromReader(SoDataReader reader, ArchiveRow row)
Parameters
Overrides
IsSaintColumn(String)
Determine whether a certain column name is a saint column or not (statuses are parsed only for the saintStatus prefix,
which is not bomb-proof but generally good enough)
Declaration
public static bool IsSaintColumn(string columnname)
Parameters
Type |
Name |
Description |
String |
columnname |
Column name, case sensitive
|
Returns
Type |
Description |
Boolean |
true if the column is a saint column
|
IsSaintEnabled(SoTable)
Is saint enabled for the current user, and the given parent entity
Declaration
public static bool IsSaintEnabled(SoTable ownerEntity)
Parameters
Type |
Name |
Description |
SoTable |
ownerEntity |
|
Returns
SetJoin()
Declaration
protected override CounterValueTableInfo SetJoin()
Returns
Overrides
SuperOffice.CRM.ArchiveLists.ExtenderBase<SuperOffice.CRM.Data.CounterValueTableInfo>.SetJoin()
SetSaintCounterJoin(ArchiveSelect, CounterValueTableInfo, Restriction)
Declaration
protected abstract void SetSaintCounterJoin(ArchiveSelect targetQuery, CounterValueTableInfo cvInfo, Restriction subClause)
Parameters
SetSaintStatusJoin(ArchiveSelect, StatusValueTableInfo, Restriction)
Declaration
protected abstract void SetSaintStatusJoin(ArchiveSelect targetQuery, StatusValueTableInfo svInfo, Restriction subClause)
Parameters
Implements
Extension Methods
EnumUtil.MapEnums<From, To>(From)