Class PersonExtenderBase
This is the base class for all extenders that add Person fields to their base query. It handles all person-related fields,
as well as having its own standard extenders for udef, email, phone and fax. Derived classes should simply implement
the method to join a PersonTableInfo to the .
Inheritance
System.Object
PersonExtenderBase
Assembly: SoDataBase.dll
Syntax
public abstract class PersonExtenderBase : TableExtenderBase<PersonTableInfo>, IArchiveProviderQueryMapping, IArchiveExtender, IArchiveProviderDoesExtend, IArchiveProviderHasColumns, IArchiveProviderExtensible, IPlugin
Constructors
PersonExtenderBase()
Construct the extender and all all standard extenders (all features)
Declaration
public PersonExtenderBase()
PersonExtenderBase(PersonExtenderBase.Features)
Construct the extender and add the requested features
Declaration
public PersonExtenderBase(PersonExtenderBase.Features features)
Parameters
Fields
_colAcademic
Declaration
protected ArchiveColumnInfo _colAcademic
Field Value
_colActiveErpLinks
Declaration
protected ArchiveColumnInfo _colActiveErpLinks
Field Value
_colAssociateFullName
Declaration
protected ArchiveColumnInfo _colAssociateFullName
Field Value
_colAssociateId
Declaration
protected ArchiveColumnInfo _colAssociateId
Field Value
_colAssociateType
Declaration
protected ArchiveColumnInfo _colAssociateType
Field Value
_colBirthDate
Declaration
protected ArchiveColumnInfo _colBirthDate
Field Value
_colBirthDay
Declaration
protected ArchiveColumnInfo _colBirthDay
Field Value
_colBirthMonth
Declaration
protected ArchiveColumnInfo _colBirthMonth
Field Value
_colBirthYear
Declaration
protected ArchiveColumnInfo _colBirthYear
Field Value
_colBusiness
Declaration
protected ArchiveColumnInfo _colBusiness
Field Value
_colCategory
Declaration
protected ArchiveColumnInfo _colCategory
Field Value
Declaration
protected ArchiveColumnInfo _colContactId
Field Value
_colCountry
Declaration
protected ArchiveColumnInfo _colCountry
Field Value
_colCountryId
Declaration
protected ArchiveColumnInfo _colCountryId
Field Value
_colDeletedDate
Declaration
protected ArchiveColumnInfo _colDeletedDate
Field Value
_colFirstName
Declaration
protected ArchiveColumnInfo _colFirstName
Field Value
_colFullName
Declaration
protected ArchiveColumnInfo _colFullName
Field Value
Declaration
protected ArchiveColumnInfo _colFullNameWithContact
Field Value
_colHasCompany
Declaration
protected ArchiveColumnInfo _colHasCompany
Field Value
_colHasInfoText
Declaration
protected ArchiveColumnInfo _colHasInfoText
Field Value
_colHasInterests
Declaration
protected ArchiveColumnInfo _colHasInterests
Field Value
_colIsProjectMember
Declaration
protected ArchiveColumnInfo _colIsProjectMember
Field Value
_colIsStakeholder
Declaration
protected ArchiveColumnInfo _colIsStakeholder
Field Value
_colKanaFirstname
Declaration
protected ArchiveColumnInfo _colKanaFirstname
Field Value
_colKanaLastname
Declaration
protected ArchiveColumnInfo _colKanaLastname
Field Value
_colLastName
Declaration
protected ArchiveColumnInfo _colLastName
Field Value
_colMiddleName
Declaration
protected ArchiveColumnInfo _colMiddleName
Field Value
_colMrMrs
Declaration
protected ArchiveColumnInfo _colMrMrs
Field Value
_colNoMailings
Declaration
protected ArchiveColumnInfo _colNoMailings
Field Value
_colNumber
Declaration
protected ArchiveColumnInfo _colNumber
Field Value
_colPersonHasInterests
Declaration
protected ArchiveColumnInfo _colPersonHasInterests
Field Value
_colPersonId
Declaration
protected ArchiveColumnInfo _colPersonId
Field Value
_colPhone
Declaration
protected ArchiveColumnInfo _colPhone
Field Value
_colPortrait
Declaration
protected ArchiveColumnInfo _colPortrait
Field Value
_colPosition
Declaration
protected ArchiveColumnInfo _colPosition
Field Value
_colRank
Declaration
protected ArchiveColumnInfo _colRank
Field Value
_colRegisteredBy
Declaration
protected ArchiveColumnInfo _colRegisteredBy
Field Value
_colRegisteredByFullName
Declaration
protected ArchiveColumnInfo _colRegisteredByFullName
Field Value
_colRegisteredDate
Declaration
protected ArchiveColumnInfo _colRegisteredDate
Field Value
_colRetired
Declaration
protected ArchiveColumnInfo _colRetired
Field Value
_colSource
Declaration
protected ArchiveColumnInfo _colSource
Field Value
_colSupportAssociate
Declaration
protected ArchiveColumnInfo _colSupportAssociate
Field Value
_colSupportAssociateFullName
Declaration
protected ArchiveColumnInfo _colSupportAssociateFullName
Field Value
_colSupportLanguage
Declaration
protected ArchiveColumnInfo _colSupportLanguage
Field Value
_colTicketPriority
Declaration
protected ArchiveColumnInfo _colTicketPriority
Field Value
_colTitle
Declaration
protected ArchiveColumnInfo _colTitle
Field Value
_colUpdatedBy
Declaration
protected ArchiveColumnInfo _colUpdatedBy
Field Value
_colUpdatedByFullName
Declaration
protected ArchiveColumnInfo _colUpdatedByFullName
Field Value
_colUpdatedDate
Declaration
protected ArchiveColumnInfo _colUpdatedDate
Field Value
_colUseAsMailingAddress
Declaration
protected ArchiveColumnInfo _colUseAsMailingAddress
Field Value
_contactExtender
Declaration
protected ContactExtenderBase _contactExtender
Field Value
Declaration
protected ContactTableInfo _contactTable
Field Value
_personHelper
Declaration
protected PersonContactExtenderHelper _personHelper
Field Value
ColCategory
Declaration
public const string ColCategory = "personCategory"
Field Value
Type |
Description |
System.String |
|
ColFullName
Declaration
public const string ColFullName = "fullName"
Field Value
Type |
Description |
System.String |
|
ColPersonHasInterests
Declaration
public const string ColPersonHasInterests = "personHasInterests"
Field Value
Type |
Description |
System.String |
|
ColumnNoMail
Declaration
public const string ColumnNoMail = "personNoMail"
Field Value
Type |
Description |
System.String |
|
ColumnRetired
Declaration
public const string ColumnRetired = "retired"
Field Value
Type |
Description |
System.String |
|
Properties
Allow subclasses to supply their own source for contact ID, for instance from the left-hand side of an outer join where
we are on the right-hand side and might therefore end up with nulls. Used in CombinedPersonExtenderBase.
Declaration
protected virtual FieldInfo ContactIdField { get; }
Property Value
DropRetiredPersons
Get/set whether persons that are retired should be dropped from the result or not (default false)
Declaration
public bool DropRetiredPersons { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Get/set whether persons that belong to companies (contacts) marked with 'stop' should be dropped from the result or not (default false)
Declaration
public bool DropStoppedContacts { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Methods
Initialize(PersonExtenderBase.Features)
Construct the object and add our own standard extenders, according to the feature list
Declaration
protected void Initialize(PersonExtenderBase.Features features)
Parameters
InnerModifyQuery()
Add/map return fields to the query; call SetJoin to obtain the contact table info instance from
the derived class
Declaration
protected override void InnerModifyQuery()
Overrides
SuperOffice.CRM.ArchiveLists.ExtenderBase<SuperOffice.CRM.Data.PersonTableInfo>.InnerModifyQuery()
InnerPopulateRowFromReader(SoDataReader, ArchiveRow)
Populate the archive row with columns that are not handled by the base class
Declaration
protected override void InnerPopulateRowFromReader(SoDataReader reader, ArchiveRow row)
Parameters
Overrides
SuperOffice.CRM.ArchiveLists.TableExtenderBase<SuperOffice.CRM.Data.PersonTableInfo>.InnerPopulateRowFromReader(SuperOffice.Data.SoDataReader, SuperOffice.CRM.ArchiveLists.ArchiveRow)
SetDesiredColumns(String[])
Override used to intercept requests for full name with contact; we need to ask our parent contact extender to please fetch the contact name+department
Declaration
public override void SetDesiredColumns(params string[] columnIds)
Parameters
Type |
Name |
Description |
System.String[] |
columnIds |
|
Overrides
SetRestriction(ArchiveRestrictionInfo[])
Declaration
public override bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Overrides
StandardFullName()
Declaration
public static ArchiveColumnInfo StandardFullName()
Returns
Implements
Extension Methods
EnumUtil.MapEnums<From, To>(From)