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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
public abstract class ContactExtenderBase : TableExtenderBase<ContactTableInfo>, IArchiveProviderQueryMapping, IArchiveExtender, IArchiveProviderDoesExtend, IArchiveProviderHasColumns, IArchiveProviderExtensible
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
Declaration
public 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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
Declaration
public ContactExtenderBase(ContactExtenderBase.Features features, string iconHint = "Contact")
Parameters
Type | Name | Description |
---|---|---|
ContactExtenderBase.Features | features | |
string | iconHint |
Fields
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
Declaration
public const string ColContactId = "contactId"
Field Value
Type | Description |
---|---|
string |
_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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
Declaration
protected ArchiveColumnInfo _colUpdatedDate
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
Declaration
public bool DropStoppedContacts { get; set; }
Property Value
Type | Description |
---|---|
bool |
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
Declaration
public ArchiveColumnData GetNameAndDepartment(SoDataReader reader)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader |
Returns
Type | Description |
---|---|
ArchiveColumnData |
Initialize(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
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
SetRestriction(params ArchiveRestrictionInfo[])
Set the restriction for the query. This method sets the restrictions for 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 restriction specification for use during query processing.
Declaration
public override bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)
Parameters
Type | Name | Description |
---|---|---|
ArchiveRestrictionInfo[] | restrictions | Array of restrictions (implicit AND) |
Returns
Type | Description |
---|---|
bool |
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 ExtenderBase.SetJoin method to join a ContactTableInfo to the RootQuery.
Declaration
public static ArchiveColumnInfo StandardNameDept()
Returns
Type | Description |
---|---|
ArchiveColumnInfo |