Class RelationContactExtenderBase
Base class for extenders that handle the contact part of a relation archive
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
public abstract class RelationContactExtenderBase : ContactExtenderBase, IArchiveProviderQueryMapping, IArchiveExtender, IArchiveProviderDoesExtend, IArchiveProviderHasColumns, IArchiveProviderExtensible, IRowNavigationHint
Remarks
This class adds functionality that is not specific to being on the source or destination side. Main functionality is to declare a 'who' column, containing the full contact name. The column name is the same for all relation extenders, by design, to provide a common 'who is this' column.
The DropStoppedContacts property is set from the outside to disable fetching of contacts marked with 'stop'. The actual handling conversion of the property into SQL is in the subclasses, since it properly belongs in the join clause. The _colRestrictionContactId column is declared and processed here. Note that it will have a runtime prefix of 'source' or 'target' depending on which side the actual class instance is on. This makes it possible to show relation archives bound to a source, a target, or both (intra-contact relations, or relations between particular contacts).Constructors
RelationContactExtenderBase()
Constructor
Declaration
public RelationContactExtenderBase()
Remarks
This class adds functionality that is not specific to being on the source or destination side. Main functionality is to declare a 'who' column, containing the full contact name. The column name is the same for all relation extenders, by design, to provide a common 'who is this' column.
The DropStoppedContacts property is set from the outside to disable fetching of contacts marked with 'stop'. The actual handling conversion of the property into SQL is in the subclasses, since it properly belongs in the join clause. The _colRestrictionContactId column is declared and processed here. Note that it will have a runtime prefix of 'source' or 'target' depending on which side the actual class instance is on. This makes it possible to show relation archives bound to a source, a target, or both (intra-contact relations, or relations between particular contacts).RelationContactExtenderBase(Features)
Constructor with the additional feature bits
Declaration
public RelationContactExtenderBase(ContactExtenderBase.Features features)
Parameters
Type | Name | Description |
---|---|---|
ContactExtenderBase.Features | features |
Remarks
This class adds functionality that is not specific to being on the source or destination side. Main functionality is to declare a 'who' column, containing the full contact name. The column name is the same for all relation extenders, by design, to provide a common 'who is this' column.
The DropStoppedContacts property is set from the outside to disable fetching of contacts marked with 'stop'. The actual handling conversion of the property into SQL is in the subclasses, since it properly belongs in the join clause. The _colRestrictionContactId column is declared and processed here. Note that it will have a runtime prefix of 'source' or 'target' depending on which side the actual class instance is on. This makes it possible to show relation archives bound to a source, a target, or both (intra-contact relations, or relations between particular contacts).Fields
_colRestrictionContactId
Base class for extenders that handle the contact part of a relation archive
Declaration
protected ArchiveColumnInfo _colRestrictionContactId
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
Remarks
This class adds functionality that is not specific to being on the source or destination side. Main functionality is to declare a 'who' column, containing the full contact name. The column name is the same for all relation extenders, by design, to provide a common 'who is this' column.
The DropStoppedContacts property is set from the outside to disable fetching of contacts marked with 'stop'. The actual handling conversion of the property into SQL is in the subclasses, since it properly belongs in the join clause. The _colRestrictionContactId column is declared and processed here. Note that it will have a runtime prefix of 'source' or 'target' depending on which side the actual class instance is on. This makes it possible to show relation archives bound to a source, a target, or both (intra-contact relations, or relations between particular contacts)._colWho
Base class for extenders that handle the contact part of a relation archive
Declaration
protected ArchiveColumnInfo _colWho
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
Remarks
This class adds functionality that is not specific to being on the source or destination side. Main functionality is to declare a 'who' column, containing the full contact name. The column name is the same for all relation extenders, by design, to provide a common 'who is this' column.
The DropStoppedContacts property is set from the outside to disable fetching of contacts marked with 'stop'. The actual handling conversion of the property into SQL is in the subclasses, since it properly belongs in the join clause. The _colRestrictionContactId column is declared and processed here. Note that it will have a runtime prefix of 'source' or 'target' depending on which side the actual class instance is on. This makes it possible to show relation archives bound to a source, a target, or both (intra-contact relations, or relations between particular contacts)._contactTable
Base class for extenders that handle the contact part of a relation archive
Declaration
protected ContactTableInfo _contactTable
Field Value
Type | Description |
---|---|
ContactTableInfo |
Remarks
This class adds functionality that is not specific to being on the source or destination side. Main functionality is to declare a 'who' column, containing the full contact name. The column name is the same for all relation extenders, by design, to provide a common 'who is this' column.
The DropStoppedContacts property is set from the outside to disable fetching of contacts marked with 'stop'. The actual handling conversion of the property into SQL is in the subclasses, since it properly belongs in the join clause. The _colRestrictionContactId column is declared and processed here. Note that it will have a runtime prefix of 'source' or 'target' depending on which side the actual class instance is on. This makes it possible to show relation archives bound to a source, a target, or both (intra-contact relations, or relations between particular contacts).Properties
TableToExtend
Base class for extenders that handle the contact part of a relation archive
Declaration
public override TableInfo TableToExtend { get; }
Property Value
Type | Description |
---|---|
TableInfo |
Overrides
Remarks
This class adds functionality that is not specific to being on the source or destination side. Main functionality is to declare a 'who' column, containing the full contact name. The column name is the same for all relation extenders, by design, to provide a common 'who is this' column.
The DropStoppedContacts property is set from the outside to disable fetching of contacts marked with 'stop'. The actual handling conversion of the property into SQL is in the subclasses, since it properly belongs in the join clause. The _colRestrictionContactId column is declared and processed here. Note that it will have a runtime prefix of 'source' or 'target' depending on which side the actual class instance is on. This makes it possible to show relation archives bound to a source, a target, or both (intra-contact relations, or relations between particular contacts).Methods
GetRowNavigationHint(SoDataReader)
Base class for extenders that handle the contact part of a relation archive
Declaration
public string GetRowNavigationHint(SoDataReader reader)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader |
Returns
Type | Description |
---|---|
string |
Remarks
This class adds functionality that is not specific to being on the source or destination side. Main functionality is to declare a 'who' column, containing the full contact name. The column name is the same for all relation extenders, by design, to provide a common 'who is this' column.
The DropStoppedContacts property is set from the outside to disable fetching of contacts marked with 'stop'. The actual handling conversion of the property into SQL is in the subclasses, since it properly belongs in the join clause. The _colRestrictionContactId column is declared and processed here. Note that it will have a runtime prefix of 'source' or 'target' depending on which side the actual class instance is on. This makes it possible to show relation archives bound to a source, a target, or both (intra-contact relations, or relations between particular contacts).InnerPopulateRowFromReader(SoDataReader, ArchiveRow)
Override: populuate the 'who' column
Declaration
protected override void InnerPopulateRowFromReader(SoDataReader reader, ArchiveRow row)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | |
ArchiveRow | row |
Overrides
Remarks
This class adds functionality that is not specific to being on the source or destination side. Main functionality is to declare a 'who' column, containing the full contact name. The column name is the same for all relation extenders, by design, to provide a common 'who is this' column.
The DropStoppedContacts property is set from the outside to disable fetching of contacts marked with 'stop'. The actual handling conversion of the property into SQL is in the subclasses, since it properly belongs in the join clause. The _colRestrictionContactId column is declared and processed here. Note that it will have a runtime prefix of 'source' or 'target' depending on which side the actual class instance is on. This makes it possible to show relation archives bound to a source, a target, or both (intra-contact relations, or relations between particular contacts).ModifyQuery()
Override: Convert the 'who' column into _colNameAndDepartment from the base class
Declaration
public override void ModifyQuery()
Overrides
Remarks
This class adds functionality that is not specific to being on the source or destination side. Main functionality is to declare a 'who' column, containing the full contact name. The column name is the same for all relation extenders, by design, to provide a common 'who is this' column.
The DropStoppedContacts property is set from the outside to disable fetching of contacts marked with 'stop'. The actual handling conversion of the property into SQL is in the subclasses, since it properly belongs in the join clause. The _colRestrictionContactId column is declared and processed here. Note that it will have a runtime prefix of 'source' or 'target' depending on which side the actual class instance is on. This makes it possible to show relation archives bound to a source, a target, or both (intra-contact relations, or relations between particular contacts).