Class DocumentExtenderWithoutDescriptionBase

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Inheritance
object
ExtensibleColumnsBase
ExtenderBase<AppointmentTableInfo>
ActivityExtenderBase<AppointmentTableInfo>
DocumentExtenderWithoutDescriptionBase
DocumentExtenderBase
LinksDocumentBySourceLeftExtender
LinksDocumentBySourceRightExtender
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
public abstract class DocumentExtenderWithoutDescriptionBase : ActivityExtenderBase<AppointmentTableInfo>, IArchiveProviderQueryMapping, IArchiveExtender, IArchiveProviderDoesExtend, IArchiveProviderHasColumns, IArchiveProviderExtensible

Constructors

DocumentExtenderWithoutDescriptionBase()

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected DocumentExtenderWithoutDescriptionBase()

DocumentExtenderWithoutDescriptionBase(Features)

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected DocumentExtenderWithoutDescriptionBase(DocumentExtenderWithoutDescriptionBase.Features features)
Parameters
Type Name Description
DocumentExtenderWithoutDescriptionBase.Features features

Fields

ColumnDocumentId

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
public const string ColumnDocumentId = "documentId"
Field Value
Type Description
string

ColumnIsMail

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
public const string ColumnIsMail = "isMail"
Field Value
Type Description
string

ColumnIsReport

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
public const string ColumnIsReport = "isReport"
Field Value
Type Description
string

_colAttention

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected ArchiveColumnInfo _colAttention
Field Value
Type Description
ArchiveColumnInfo

_colId

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected ArchiveColumnInfo _colId
Field Value
Type Description
ArchiveColumnInfo

_colIsMail

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected ArchiveColumnInfo _colIsMail
Field Value
Type Description
ArchiveColumnInfo

_colIsReport

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected ArchiveColumnInfo _colIsReport
Field Value
Type Description
ArchiveColumnInfo

_colKeywords

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected ArchiveColumnInfo _colKeywords
Field Value
Type Description
ArchiveColumnInfo

_colMailmergeDraft

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected ArchiveColumnInfo _colMailmergeDraft
Field Value
Type Description
ArchiveColumnInfo

_colName

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected ArchiveColumnInfo _colName
Field Value
Type Description
ArchiveColumnInfo

_colOurref

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected ArchiveColumnInfo _colOurref
Field Value
Type Description
ArchiveColumnInfo

_colRecordTypeText

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected ArchiveColumnInfo _colRecordTypeText
Field Value
Type Description
ArchiveColumnInfo

_colSNum

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected ArchiveColumnInfo _colSNum
Field Value
Type Description
ArchiveColumnInfo

_colSubject

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected ArchiveColumnInfo _colSubject
Field Value
Type Description
ArchiveColumnInfo

_colSuggestedDocument

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected ArchiveColumnInfo _colSuggestedDocument
Field Value
Type Description
ArchiveColumnInfo

_colYourref

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected ArchiveColumnInfo _colYourref
Field Value
Type Description
ArchiveColumnInfo

_features

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected DocumentExtenderWithoutDescriptionBase.Features _features
Field Value
Type Description
DocumentExtenderWithoutDescriptionBase.Features

_ourAppointmentTable

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected AppointmentTableInfo _ourAppointmentTable
Field Value
Type Description
AppointmentTableInfo

_ourDocTmplTable

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected DocTmplTableInfo _ourDocTmplTable
Field Value
Type Description
DocTmplTableInfo

_ourDocumentTable

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected DocumentTableInfo _ourDocumentTable
Field Value
Type Description
DocumentTableInfo

_ourRecordTypeDocTmplTable

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected DocTmplTableInfo _ourRecordTypeDocTmplTable
Field Value
Type Description
DocTmplTableInfo

_siblingAppointment

If set, get appointmentTableInfo instance from this sibling and patch restrictions, to avoid join multiplications

Declaration
protected ExtensibleColumnsBase _siblingAppointment
Field Value
Type Description
ExtensibleColumnsBase

Properties

AppointmentTable

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
public AppointmentTableInfo AppointmentTable { get; }
Property Value
Type Description
AppointmentTableInfo

MainTableName

The name of the table that this node is the handler for

Declaration
public override string MainTableName { get; }
Property Value
Type Description
string
Overrides

TableToExtend

Return the table to extend, as defined by THIS extender class.

Declaration
public override TableInfo TableToExtend { get; }
Property Value
Type Description
TableInfo
Overrides

VisibleForTable

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
public VisibleForTableInfo VisibleForTable { get; }
Property Value
Type Description
VisibleForTableInfo

Methods

GetOrCreateAppointmentTableInfo()

Obtain the correct AppointmentTableInfo instance, either from our sibling or a new one

Declaration
protected AppointmentTableInfo GetOrCreateAppointmentTableInfo()
Returns
Type Description
AppointmentTableInfo

GetStandardTooltipHint(SoDataReader, FieldInfo)

Override: The standard tooltip hint is used for fields that come from the same table as the primary key field. Since we use appoint.document_id as the primary key for this two-table provider, that model doesn't fit. Instead, we simply return a hardcoded document tooltip that fits our simple needs.

Declaration
protected override string GetStandardTooltipHint(SoDataReader reader, FieldInfo actualDataField)
Parameters
Type Name Description
SoDataReader reader
FieldInfo actualDataField
Returns
Type Description
string
Overrides

InnerModifyQuery()

Template method called from ModifyQuery() during query processing; subclasses should implement it to build their queries. It will ONLY be called if IsQueryNeeded returns true.

Declaration
protected override void InnerModifyQuery()
Overrides

InnerPopulateRowFromReader(SoDataReader, ArchiveRow)

Derived classes should implement the population of ColumnData items for columns that are NOT handled by this base class in this method. Whether a column is handled by this base class is part of its database binding information, set by the various MapXXX methods.

Declaration
protected override void InnerPopulateRowFromReader(SoDataReader reader, ArchiveRow row)
Parameters
Type Name Description
SoDataReader reader

Data reader with the query result (one row)
ArchiveRow row

archive row to be populated
Overrides

ProcessRestrictions()

Process restrictions during query processing. This is where the abstract syntax of the ArchiveRestrictionInfo objects is converted into Restriction clauses, and string-formatted parameters are converted into their proper form.

Declaration
protected override bool ProcessRestrictions()
Returns
Type Description
bool

true if at least one of the currently set restrictions matched an available and bound column and was processed
Overrides

SetDualJoin(out AppointmentTableInfo, out DocumentTableInfo)

Document extender base. This class is the same as the DocumentExtenderBase but without linking in the description in the text column

Declaration
protected abstract void SetDualJoin(out AppointmentTableInfo appointmentTable, out DocumentTableInfo documentTable)
Parameters
Type Name Description
AppointmentTableInfo appointmentTable
DocumentTableInfo documentTable

SetJoin()

Subclass contract: Implementations of this method should create the extenders' table information object, join it to the relevant parent, and return the table information instance

Declaration
protected override AppointmentTableInfo SetJoin()
Returns
Type Description
AppointmentTableInfo
Overrides

Implements

Extension Methods