Class ContactExtenderBase

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Inheritance
Object
ExtensibleColumnsBase
ExtenderBase<ContactTableInfo>
TableExtenderBase<ContactTableInfo>
ContactExtenderBase
AppointmentContactExtender
ChatSessionContactExtender
CombinedContactExtenderBase
ContactContactExtender
ContactLinkExtender
DocumentContactExtender
EmailItemContactExtender
FavouriteContactExtender
FormSubmissionContactExtender
TicketContactExtender
MailingAddrContactExtender
PersonContactExtender
ProjectContactExtender
ProjectMemberContactExtender
RecycleContactExtender
RelationContactExtenderBase
SaleContactExtender
SaleHistoryContactExtender
SaleStakeholderContactExtender
SimpleContactExtender
TargetAssignmentValueContactExtender
WorkflowInstanceContactExtender
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
public abstract class ContactExtenderBase : TableExtenderBase<ContactTableInfo>, IArchiveProviderQueryMapping, IArchiveExtender, IArchiveProviderDoesExtend, IArchiveProviderHasColumns, IArchiveProviderExtensible, IPlugin

Constructors

ContactExtenderBase()

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
public ContactExtenderBase()

ContactExtenderBase(ContactExtenderBase.Features, String)

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
public ContactExtenderBase(ContactExtenderBase.Features features, string iconHint = "Contact")
Parameters
Type Name Description
ContactExtenderBase.Features features
String iconHint

Fields

_colActiveErpLinks

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colActiveErpLinks
Field Value
Type Description
ArchiveColumnInfo

_colAssociateId

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colAssociateId
Field Value
Type Description
ArchiveColumnInfo

_colBusiness

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colBusiness
Field Value
Type Description
ArchiveColumnInfo

_colCategory

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colCategory
Field Value
Type Description
ArchiveColumnInfo

_colCode

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colCode
Field Value
Type Description
ArchiveColumnInfo

_colContactId

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colContactId
Field Value
Type Description
ArchiveColumnInfo

_colCountry

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colCountry
Field Value
Type Description
ArchiveColumnInfo

_colCountryId

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colCountryId
Field Value
Type Description
ArchiveColumnInfo

_colDeleted

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colDeleted
Field Value
Type Description
ArchiveColumnInfo

_colDeletedDate

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colDeletedDate
Field Value
Type Description
ArchiveColumnInfo

_colDepartment

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colDepartment
Field Value
Type Description
ArchiveColumnInfo

_colHasInfoText

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colHasInfoText
Field Value
Type Description
ArchiveColumnInfo

_colHasInterests

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colHasInterests
Field Value
Type Description
ArchiveColumnInfo

_colMainContact

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colMainContact
Field Value
Type Description
ArchiveColumnInfo

_colName

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colName
Field Value
Type Description
ArchiveColumnInfo

_colNameAndDepartment

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colNameAndDepartment
Field Value
Type Description
ArchiveColumnInfo

_colNoMail

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colNoMail
Field Value
Type Description
ArchiveColumnInfo

_colNumber

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colNumber
Field Value
Type Description
ArchiveColumnInfo

_colOrgNr

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colOrgNr
Field Value
Type Description
ArchiveColumnInfo

_colPhone

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colPhone
Field Value
Type Description
ArchiveColumnInfo

_colRegisteredBy

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colRegisteredBy
Field Value
Type Description
ArchiveColumnInfo

_colRegisteredByFullName

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colRegisteredByFullName
Field Value
Type Description
ArchiveColumnInfo

_colRegisteredDate

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colRegisteredDate
Field Value
Type Description
ArchiveColumnInfo

_colSource

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colSource
Field Value
Type Description
ArchiveColumnInfo

_colStop

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colStop
Field Value
Type Description
ArchiveColumnInfo

_colUpdatedBy

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colUpdatedBy
Field Value
Type Description
ArchiveColumnInfo

_colUpdatedByFullName

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colUpdatedByFullName
Field Value
Type Description
ArchiveColumnInfo

_colUpdatedDate

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
protected ArchiveColumnInfo _colUpdatedDate
Field Value
Type Description
ArchiveColumnInfo

ColCategory

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
public const string ColCategory = "category"
Field Value
Type Description
String

ColContactId

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
public const string ColContactId = "contactId"
Field Value
Type Description
String

Properties

DropStoppedContacts

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
public bool DropStoppedContacts { get; set; }
Property Value
Type Description
Boolean

Methods

GetNameAndDepartment(SoDataReader)

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
public ArchiveColumnData GetNameAndDepartment(SoDataReader reader)
Parameters
Type Name Description
SoDataReader reader
Returns
Type Description
ArchiveColumnData

Initialize(ContactExtenderBase.Features, String)

Construct the extender and add all standard extenders

Declaration
public void Initialize(ContactExtenderBase.Features features, string iconHint)
Parameters
Type Name Description
ContactExtenderBase.Features features
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
SuperOffice.CRM.ArchiveLists.ExtenderBase<SuperOffice.CRM.Data.ContactTableInfo>.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
Type Name Description
SoDataReader reader

Reader with data fields
ArchiveRow row

Row to be populated
Overrides
SuperOffice.CRM.ArchiveLists.TableExtenderBase<SuperOffice.CRM.Data.ContactTableInfo>.InnerPopulateRowFromReader(SuperOffice.Data.SoDataReader, SuperOffice.CRM.ArchiveLists.ArchiveRow)

SetRestriction(ArchiveRestrictionInfo[])

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
public override bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)
Parameters
Type Name Description
ArchiveRestrictionInfo[] restrictions
Returns
Type Description
Boolean
Overrides

StandardNameDept()

This is the base class for all extenders that add Contact fields to their base query. It handles all contact-related fields, as well as having its own standard extenders for udef, email, url, phone and fax. Derived classes should simply implement the method to join a ContactTableInfo to the .

Declaration
public static ArchiveColumnInfo StandardNameDept()
Returns
Type Description
ArchiveColumnInfo

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)