Class ProjectGuideSubProviderBase<RootExtender>

Common base class for the Appointment and Document providers for Project Guide items

Inheritance
System.Object
ExtensibleColumnsBase
QueryProviderBase<ArchiveRow>
TypedQueryProviderBase<ArchiveRow, RootExtender>
ProjectGuideSubProviderBase<RootExtender>
ProjectGuideAppointmentProvider
ProjectGuideDocumentProvider
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
public abstract class ProjectGuideSubProviderBase<RootExtender> : TypedQueryProviderBase<ArchiveRow, RootExtender>, IArchiveProviderQueryMapping, IArchiveQueryProvider, IArchiveProviderExtensible, IArchiveTypedProvider<ArchiveRow>, IArchiveTypedProviderBase, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities, IPlugin where RootExtender : IArchiveExtender, new()
Type Parameters
Name Description
RootExtender
Remarks

Most of the actual processing is done by the extenders, which have common base classes for Appointment and Document, and are further subdivided into project and (in the future?) project as the ultimate parent entity. This provider handles the sentry processing, which does not really fit anywhere else.

Part of the sentry processing consists of getting hold of the correct tableinfos that represent the instance information, and then using it to derive the correct rights. Subclasses supply the instances, and this base class then uses it in the calculations.

Constructors

ProjectGuideSubProviderBase(ArchiveRowTypeInfo)

Declaration
public ProjectGuideSubProviderBase(ArchiveRowTypeInfo rowType)
Parameters
Type Name Description
ArchiveRowTypeInfo rowType

Fields

_colId

Declaration
protected ArchiveColumnInfo _colId
Field Value
Type Description
ArchiveColumnInfo

OnlyInstanceEntityName

Declaration
public const string OnlyInstanceEntityName = "onlyInstance"
Field Value
Type Description
System.String

Properties

InhibitDistinctPrimaryKeys

We change entities on the fly and should not really need to do this??

Declaration
public override bool InhibitDistinctPrimaryKeys { get; }
Property Value
Type Description
System.Boolean
Overrides
SuperOffice.CRM.ArchiveLists.QueryProviderBase<SuperOffice.CRM.ArchiveLists.ArchiveRow>.InhibitDistinctPrimaryKeys

InstanceTable

Get the specific instance table - either appointment or document

Declaration
protected abstract TableInfo InstanceTable { get; }
Property Value
Type Description
TableInfo

TableToExtend

Declaration
public override TableInfo TableToExtend { get; }
Property Value
Type Description
TableInfo
Overrides
SuperOffice.CRM.ArchiveLists.QueryProviderBase<SuperOffice.CRM.ArchiveLists.ArchiveRow>.TableToExtend

Methods

AcceptRow(SoDataReader)

Override: Filter out rows where the stagelinkinfo.deleted != 0, provided they have no instance

Declaration
protected override bool AcceptRow(SoDataReader reader)
Parameters
Type Name Description
SoDataReader reader
Returns
Type Description
System.Boolean
Overrides
SuperOffice.CRM.ArchiveLists.QueryProviderBase<SuperOffice.CRM.ArchiveLists.ArchiveRow>.AcceptRow(SuperOffice.Data.SoDataReader)

GetInsertRight(Int32)

Get the Insert right, based on the current project owner

Declaration
protected abstract TableRight GetInsertRight(int ownerAssociate)
Parameters
Type Name Description
System.Int32 ownerAssociate

owner associate to use
Returns
Type Description
TableRight
Remarks

The business rules state that new instances are created on behalf of the user who owns the project, not the current user. We therefore need to determine if the current user is allowed to insert something owned by the project owner.

GetInstanceAppointment()

Get the appointment instance table

Declaration
protected AppointmentTableInfo GetInstanceAppointment()
Returns
Type Description
AppointmentTableInfo
Remarks

This method is placed here because both the appointment and the document subclasses use it (remember appointment->document)

HasInstance(SoDataReader)

Declaration
protected bool HasInstance(SoDataReader reader)
Parameters
Type Name Description
SoDataReader reader
Returns
Type Description
System.Boolean

InnerMapFields()

Override: Make sure we have the project associate ID field, and map the project id

Declaration
public override void InnerMapFields()
Overrides
SuperOffice.CRM.ArchiveLists.QueryProviderBase<SuperOffice.CRM.ArchiveLists.ArchiveRow>.InnerMapFields()

InnerPopulateRowFromReader(SoDataReader, ArchiveRow)

Override: Use the instance table and insert rights from the subclass to calculate the correct table rights.

Declaration
protected override void InnerPopulateRowFromReader(SoDataReader reader, ArchiveRow row)
Parameters
Type Name Description
SoDataReader reader
ArchiveRow row
Overrides
SuperOffice.CRM.ArchiveLists.TypedQueryProviderBase<SuperOffice.CRM.ArchiveLists.ArchiveRow, RootExtender>.InnerPopulateRowFromReader(SuperOffice.Data.SoDataReader, SuperOffice.CRM.ArchiveLists.ArchiveRow)
Remarks

The Insert part of the table right is based on the relationship between the current user and the project owner. The Read/Update/Delete part is based on the actual instance, if any. New-instance rights are cached per project owner to make it go faster.

PostProcessQuery()

Declaration
public override void PostProcessQuery()
Overrides
SuperOffice.CRM.ArchiveLists.QueryProviderBase<SuperOffice.CRM.ArchiveLists.ArchiveRow>.PostProcessQuery()

RequiredPhaseOneFields()

Make sure the fields we need in AcceptRow are always present in the phase-one version of the query

Declaration
protected override FieldInfo[] RequiredPhaseOneFields()
Returns
Type Description
FieldInfo[]
Overrides
SuperOffice.CRM.ArchiveLists.QueryProviderBase<SuperOffice.CRM.ArchiveLists.ArchiveRow>.RequiredPhaseOneFields()

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)