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
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
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
Type | Name | Description |
---|---|---|
PersonExtenderBase.Features | features |
PersonExtenderBase(PersonExtenderBase.Features, String, String)
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
Declaration
public PersonExtenderBase(PersonExtenderBase.Features features, string context, string iconHint = "Person")
Parameters
Type | Name | Description |
---|---|---|
PersonExtenderBase.Features | features | |
String | context | |
String | iconHint |
Fields
_colAcademic
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
Declaration
protected ArchiveColumnInfo _colAcademic
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colActiveErpLinks
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
Declaration
protected ArchiveColumnInfo _colActiveErpLinks
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colAssociateFullName
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
Declaration
protected ArchiveColumnInfo _colAssociateFullName
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colAssociateId
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
Declaration
protected ArchiveColumnInfo _colAssociateId
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colAssociateType
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
Declaration
protected ArchiveColumnInfo _colAssociateType
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colBirthDate
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
Declaration
protected ArchiveColumnInfo _colBirthDate
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colBirthDay
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
Declaration
protected ArchiveColumnInfo _colBirthDay
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colBirthMonth
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
Declaration
protected ArchiveColumnInfo _colBirthMonth
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colBirthYear
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
Declaration
protected ArchiveColumnInfo _colBirthYear
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colBusiness
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
Declaration
protected ArchiveColumnInfo _colBusiness
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colCategory
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
Declaration
protected ArchiveColumnInfo _colCategory
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colContactId
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
Declaration
protected ArchiveColumnInfo _colContactId
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colCountry
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
Declaration
protected ArchiveColumnInfo _colCountry
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colCountryId
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
Declaration
protected ArchiveColumnInfo _colCountryId
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colCreatedByForm
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
Declaration
protected ArchiveColumnInfo _colCreatedByForm
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colDeletedDate
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
Declaration
protected ArchiveColumnInfo _colDeletedDate
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colFirstName
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
Declaration
protected ArchiveColumnInfo _colFirstName
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colFullName
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
Declaration
protected ArchiveColumnInfo _colFullName
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colFullNameWithContact
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
Declaration
protected ArchiveColumnInfo _colFullNameWithContact
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colHasCompany
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
Declaration
protected ArchiveColumnInfo _colHasCompany
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colHasInfoText
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
Declaration
protected ArchiveColumnInfo _colHasInfoText
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colHasInterests
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
Declaration
protected ArchiveColumnInfo _colHasInterests
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colIsProjectMember
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
Declaration
protected ArchiveColumnInfo _colIsProjectMember
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colIsStakeholder
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
Declaration
protected ArchiveColumnInfo _colIsStakeholder
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colKanaFirstname
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
Declaration
protected ArchiveColumnInfo _colKanaFirstname
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colKanaLastname
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
Declaration
protected ArchiveColumnInfo _colKanaLastname
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colLastName
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
Declaration
protected ArchiveColumnInfo _colLastName
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colMiddleName
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
Declaration
protected ArchiveColumnInfo _colMiddleName
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colMrMrs
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
Declaration
protected ArchiveColumnInfo _colMrMrs
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colNoMailings
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
Declaration
protected ArchiveColumnInfo _colNoMailings
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colNumber
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
Declaration
protected ArchiveColumnInfo _colNumber
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colPersonHasInterests
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
Declaration
protected ArchiveColumnInfo _colPersonHasInterests
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colPersonId
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
Declaration
protected ArchiveColumnInfo _colPersonId
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colPhone
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
Declaration
protected ArchiveColumnInfo _colPhone
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colPortrait
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
Declaration
protected ArchiveColumnInfo _colPortrait
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colPosition
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
Declaration
protected ArchiveColumnInfo _colPosition
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colRank
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
Declaration
protected ArchiveColumnInfo _colRank
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colRegisteredBy
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
Declaration
protected ArchiveColumnInfo _colRegisteredBy
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colRegisteredByFullName
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
Declaration
protected ArchiveColumnInfo _colRegisteredByFullName
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colRegisteredDate
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
Declaration
protected ArchiveColumnInfo _colRegisteredDate
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colRetired
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
Declaration
protected ArchiveColumnInfo _colRetired
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colSource
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
Declaration
protected ArchiveColumnInfo _colSource
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colSupportAssociate
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
Declaration
protected ArchiveColumnInfo _colSupportAssociate
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colSupportAssociateFullName
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
Declaration
protected ArchiveColumnInfo _colSupportAssociateFullName
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colSupportLanguage
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
Declaration
protected ArchiveColumnInfo _colSupportLanguage
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colTicketPriority
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
Declaration
protected ArchiveColumnInfo _colTicketPriority
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colTitle
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
Declaration
protected ArchiveColumnInfo _colTitle
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colUpdatedBy
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
Declaration
protected ArchiveColumnInfo _colUpdatedBy
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colUpdatedByFullName
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
Declaration
protected ArchiveColumnInfo _colUpdatedByFullName
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colUpdatedByWorkflow
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
Declaration
protected ArchiveColumnInfo _colUpdatedByWorkflow
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colUpdatedDate
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
Declaration
protected ArchiveColumnInfo _colUpdatedDate
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colUseAsMailingAddress
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
Declaration
protected ArchiveColumnInfo _colUseAsMailingAddress
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_colWhenUpdatedByWorkflow
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
Declaration
protected ArchiveColumnInfo _colWhenUpdatedByWorkflow
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
_contactExtender
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
Declaration
protected ContactExtenderBase _contactExtender
Field Value
Type | Description |
---|---|
ContactExtenderBase |
_contactTable
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
Declaration
protected ContactTableInfo _contactTable
Field Value
Type | Description |
---|---|
ContactTableInfo |
_personHelper
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
Declaration
protected PersonContactExtenderHelper _personHelper
Field Value
Type | Description |
---|---|
PersonContactExtenderHelper |
ColCategory
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
Declaration
public const string ColCategory = "personCategory"
Field Value
Type | Description |
---|---|
String |
ColFullName
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
Declaration
public const string ColFullName = "fullName"
Field Value
Type | Description |
---|---|
String |
ColPersonHasInterests
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
Declaration
public const string ColPersonHasInterests = "personHasInterests"
Field Value
Type | Description |
---|---|
String |
ColumnNoMail
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
Declaration
public const string ColumnNoMail = "personNoMail"
Field Value
Type | Description |
---|---|
String |
ColumnRetired
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
Declaration
public const string ColumnRetired = "retired"
Field Value
Type | Description |
---|---|
String |
Properties
ContactIdField
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
Type | Description |
---|---|
FieldInfo |
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 |
---|---|
Boolean |
DropStoppedContacts
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 |
---|---|
Boolean |
Methods
Initialize(PersonExtenderBase.Features, String, String)
Construct the object and add our own standard extenders, according to the feature list
Declaration
protected void Initialize(PersonExtenderBase.Features features, string context = "", string iconHint = "Person")
Parameters
Type | Name | Description |
---|---|---|
PersonExtenderBase.Features | features | |
String | context | |
String | iconHint |
Remarks
Sub-entity prefixes are set up so that there is intentional overlap between contact and person. Usually, contact and person themselves are prefixed, thereby also keeping the subentitites apart. However, in the case were we want to combine contact and person (such as during a search), we also want (most of) the subentities to overlap - which we achieve by prefixing them the same way in both person and contact, or not all.
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
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
Type | Name | Description |
---|---|---|
SoDataReader | reader | Reader with data fields |
ArchiveRow | row | Row to be populated |
Overrides
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 |
---|---|---|
String[] | columnIds |
Overrides
SetRestriction(ArchiveRestrictionInfo[])
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
Declaration
public override bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)
Parameters
Type | Name | Description |
---|---|---|
ArchiveRestrictionInfo[] | restrictions |
Returns
Type | Description |
---|---|
Boolean |
Overrides
StandardFullName()
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
Declaration
public static ArchiveColumnInfo StandardFullName()
Returns
Type | Description |
---|---|
ArchiveColumnInfo |