Class AppointmentExtenderBase
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
public abstract class AppointmentExtenderBase : ActivityExtenderBase<AppointmentTableInfo>, IArchiveProviderQueryMapping, IArchiveExtender, IArchiveProviderDoesExtend, IArchiveProviderHasColumns, IArchiveProviderExtensible, IArchiveProviderExtenderAccept
Constructors
AppointmentExtenderBase()
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected AppointmentExtenderBase()
AppointmentExtenderBase(Features, string)
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected AppointmentExtenderBase(AppointmentExtenderBase.Features features, string iconHint = "Appointment")
Parameters
| Type | Name | Description |
|---|---|---|
| AppointmentExtenderBase.Features | features | |
| string | iconHint |
Fields
ColumnAppointmentId
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
public const string ColumnAppointmentId = "appointmentId"
Field Value
| Type | Description |
|---|---|
| string |
ColumnCautionWarning
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
public const string ColumnCautionWarning = "cautionWarning"
Field Value
| Type | Description |
|---|---|
| string |
ColumnInvitedPersonId
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
public const string ColumnInvitedPersonId = "invitedPersonId"
Field Value
| Type | Description |
|---|---|
| string |
ColumnRawStatus
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
public const string ColumnRawStatus = "rawStatus"
Field Value
| Type | Description |
|---|---|
| string |
ColumnRawType
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
public const string ColumnRawType = "rawType"
Field Value
| Type | Description |
|---|---|
| string |
ColumnRecurrenceRuleId
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
public const string ColumnRecurrenceRuleId = "recurrenceRuleId"
Field Value
| Type | Description |
|---|---|
| string |
ColumnVisibleInDiary
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
public const string ColumnVisibleInDiary = "visibleInDiary"
Field Value
| Type | Description |
|---|---|
| string |
_colAlarm
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colAlarm
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colBooking
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colBooking
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colCautionWarning
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colCautionWarning
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colCompletedDate
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colCompletedDate
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colCreatedByWorkflow
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colCreatedByWorkflow
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colDuration
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colDuration
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colEndDate
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colEndDate
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colEndTime
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colEndTime
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colId
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colId
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colIntention
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colIntention
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colInvitedPersonId
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colInvitedPersonId
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colIsFree
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colIsFree
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colIsMilestone
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colIsMilestone
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colJoinVideomeetUrl
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colJoinVideomeetUrl
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colLocation
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colLocation
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colPriority
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colPriority
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colRawStatus
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colRawStatus
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colRawType
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colRawType
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colRecordTypeText
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colRecordTypeText
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colRecurrencId
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colRecurrencId
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colRecurring
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colRecurring
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colSuggestedAppointment
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colSuggestedAppointment
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_colVisibleInDiary
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected ArchiveColumnInfo _colVisibleInDiary
Field Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
_expandPersonIdRestriction
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
protected bool _expandPersonIdRestriction
Field Value
| Type | Description |
|---|---|
| bool |
_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
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
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
public VisibleForTableInfo VisibleForTable { get; }
Property Value
| Type | Description |
|---|---|
| VisibleForTableInfo |
Methods
AcceptRow(SoDataReader)
Possibility for the extenders to have an AcceptRow(). Alternatively implement this on Extender base class...
Declaration
public bool AcceptRow(SoDataReader reader)
Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader |
Returns
| Type | Description |
|---|---|
| bool | The reader from which to get row data. Remember to make sure the data is there when asked for, you should perhaps ask for it in InnerModifyQuery() |
Remarks
Method is invoked on child extenders and stops at the first one returning false.
AppointmentIconHint(AppointmentType, DocTmplType, DocTmplDirection)
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
public static string AppointmentIconHint(AppointmentType basicType, DocTmplType recordType, DocTmplDirection direction)
Parameters
| Type | Name | Description |
|---|---|---|
| AppointmentType | basicType | |
| DocTmplType | recordType | |
| DocTmplDirection | direction |
Returns
| Type | Description |
|---|---|
| string |
GetOrCreateAppointmentTableInfo()
Obtain the correct AppointmentTableInfo instance, either from our sibling or a new one
Declaration
protected AppointmentTableInfo GetOrCreateAppointmentTableInfo()
Returns
| Type | Description |
|---|---|
| AppointmentTableInfo |
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
ModifyQuery()
Interface implementation, called from outer query provider to build the query
Declaration
public override void ModifyQuery()
Overrides
ProcessOrderBy()
Process order by information during query modification. For each order by column that matches a known database binding, add the orderby clause to the query. If the column has a separate fieldinfo specified for its orderby (as specified by MapOrderByField(FieldInfo, ArchiveColumnInfo), this field is used, otherwise the display field is used).
Declaration
protected override void ProcessOrderBy()
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
RequiredPhaseOneFields()
Base extender class that handles appointments. Depending on the SuperOffice.CRM.ArchiveLists.Features requested, this extender will create and link other extenders for related data - potentially quite deep.
Declaration
public FieldInfo[] RequiredPhaseOneFields()
Returns
| Type | Description |
|---|---|
| FieldInfo[] |
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 |