Class InvitationProvider
Invitation provider multichannel combiner, consisting of simple, cancelled, rejected, repeating and response invitations. You can also call up appointments explicitly through the Explicit provider.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
[ArchiveProvider("Invitation", 1073741823)]
public class InvitationProvider : BufferedQueryProviderBase<ArchiveInvitationRow, InvitationProviderCombiner>, IArchiveInvitationProvider, IArchiveTypedProvider<ArchiveInvitationRow>, IArchiveTypedProviderBase, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntitiesRemarks
SimpleInvitationProviderResponseInvitationProviderCancelledInvitationProvider RepeatingInvitationProviderRejectedInvitationProviderExplicitInvitationProvider The final result set needs filtering to remove repeating records if we are running in "compressed" mode, and also reordering to make sure we get the right order. We also need to filter repeating bookings against explicit records to remove duplicates there, because someone may explicitly request an instance an a recurring booking, so that all other instances should be suppressed.
Constructors
InvitationProvider()
Invitation provider multichannel combiner, consisting of simple, cancelled, rejected, repeating and response invitations. You can also call up appointments explicitly through the Explicit provider.
Declaration
public InvitationProvider()Remarks
SimpleInvitationProviderResponseInvitationProviderCancelledInvitationProvider RepeatingInvitationProviderRejectedInvitationProviderExplicitInvitationProvider The final result set needs filtering to remove repeating records if we are running in "compressed" mode, and also reordering to make sure we get the right order. We also need to filter repeating bookings against explicit records to remove duplicates there, because someone may explicitly request an instance an a recurring booking, so that all other instances should be suppressed.
Fields
ProviderName
Invitation provider multichannel combiner, consisting of simple, cancelled, rejected, repeating and response invitations. You can also call up appointments explicitly through the Explicit provider.
Declaration
public const string ProviderName = "Invitation"Field Value
| Type | Description |
|---|---|
| string |
Remarks
SimpleInvitationProviderResponseInvitationProviderCancelledInvitationProvider RepeatingInvitationProviderRejectedInvitationProviderExplicitInvitationProvider The final result set needs filtering to remove repeating records if we are running in "compressed" mode, and also reordering to make sure we get the right order. We also need to filter repeating bookings against explicit records to remove duplicates there, because someone may explicitly request an instance an a recurring booking, so that all other instances should be suppressed.
_colInvitationStatusNotSeenByMe
Invitation provider multichannel combiner, consisting of simple, cancelled, rejected, repeating and response invitations. You can also call up appointments explicitly through the Explicit provider.
Declaration
protected ArchiveColumnInfo _colInvitationStatusNotSeenByMeField Value
| Type | Description |
|---|---|
| ArchiveColumnInfo |
Remarks
SimpleInvitationProviderResponseInvitationProviderCancelledInvitationProvider RepeatingInvitationProviderRejectedInvitationProviderExplicitInvitationProvider The final result set needs filtering to remove repeating records if we are running in "compressed" mode, and also reordering to make sure we get the right order. We also need to filter repeating bookings against explicit records to remove duplicates there, because someone may explicitly request an instance an a recurring booking, so that all other instances should be suppressed.
Properties
AdditionalDesiredColumns
Invitation provider multichannel combiner, consisting of simple, cancelled, rejected, repeating and response invitations. You can also call up appointments explicitly through the Explicit provider.
Declaration
protected override string[] AdditionalDesiredColumns { get; }Property Value
| Type | Description |
|---|---|
| string[] |
Overrides
Remarks
SimpleInvitationProviderResponseInvitationProviderCancelledInvitationProvider RepeatingInvitationProviderRejectedInvitationProviderExplicitInvitationProvider The final result set needs filtering to remove repeating records if we are running in "compressed" mode, and also reordering to make sure we get the right order. We also need to filter repeating bookings against explicit records to remove duplicates there, because someone may explicitly request an instance an a recurring booking, so that all other instances should be suppressed.
BaseClassShouldFilterColumns
Override: Let the inner provider (not the InMemoryProvider base class) filter columns
Declaration
protected override bool BaseClassShouldFilterColumns { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
Remarks
SimpleInvitationProviderResponseInvitationProviderCancelledInvitationProvider RepeatingInvitationProviderRejectedInvitationProviderExplicitInvitationProvider The final result set needs filtering to remove repeating records if we are running in "compressed" mode, and also reordering to make sure we get the right order. We also need to filter repeating bookings against explicit records to remove duplicates there, because someone may explicitly request an instance an a recurring booking, so that all other instances should be suppressed.
BaseClassShouldFilterEntities
Override: Let the base class filter entitities, we will mark them for filtering
Declaration
protected override bool BaseClassShouldFilterEntities { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
Remarks
SimpleInvitationProviderResponseInvitationProviderCancelledInvitationProvider RepeatingInvitationProviderRejectedInvitationProviderExplicitInvitationProvider The final result set needs filtering to remove repeating records if we are running in "compressed" mode, and also reordering to make sure we get the right order. We also need to filter repeating bookings against explicit records to remove duplicates there, because someone may explicitly request an instance an a recurring booking, so that all other instances should be suppressed.
BaseClassShouldPage
Override: Let the base class do paging (this stategy fails if there are a gazillion invitations!)
Declaration
protected override bool BaseClassShouldPage { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
Remarks
SimpleInvitationProviderResponseInvitationProviderCancelledInvitationProvider RepeatingInvitationProviderRejectedInvitationProviderExplicitInvitationProvider The final result set needs filtering to remove repeating records if we are running in "compressed" mode, and also reordering to make sure we get the right order. We also need to filter repeating bookings against explicit records to remove duplicates there, because someone may explicitly request an instance an a recurring booking, so that all other instances should be suppressed.
BaseClassShouldSort
Override: Let the base class do orderBy, since our filtering may mess up the orderby
Declaration
protected override bool BaseClassShouldSort { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
Remarks
SimpleInvitationProviderResponseInvitationProviderCancelledInvitationProvider RepeatingInvitationProviderRejectedInvitationProviderExplicitInvitationProvider The final result set needs filtering to remove repeating records if we are running in "compressed" mode, and also reordering to make sure we get the right order. We also need to filter repeating bookings against explicit records to remove duplicates there, because someone may explicitly request an instance an a recurring booking, so that all other instances should be suppressed.
Methods
GetResultData()
Subclass contract: Return a list of ArchiveRow items that are the current result
Declaration
protected override List<ArchiveInvitationRow> GetResultData()Returns
| Type | Description |
|---|---|
| List<ArchiveInvitationRow> | result list, which may be paged, sorted and column-filtered, or not, according to the abstract properties |
Overrides
Remarks
SimpleInvitationProviderResponseInvitationProviderCancelledInvitationProvider RepeatingInvitationProviderRejectedInvitationProviderExplicitInvitationProvider The final result set needs filtering to remove repeating records if we are running in "compressed" mode, and also reordering to make sure we get the right order. We also need to filter repeating bookings against explicit records to remove duplicates there, because someone may explicitly request an instance an a recurring booking, so that all other instances should be suppressed.
SetAssociateId(int)
Set the id of the associate we wish to fetch invitations for. This is equivalent to setting the 'associateId' restriction with a unique value.
Declaration
public void SetAssociateId(int associateId)Parameters
| Type | Name | Description |
|---|---|---|
| int | associateId | Associate id to fetch invitations for |
Remarks
SimpleInvitationProviderResponseInvitationProviderCancelledInvitationProvider RepeatingInvitationProviderRejectedInvitationProviderExplicitInvitationProvider The final result set needs filtering to remove repeating records if we are running in "compressed" mode, and also reordering to make sure we get the right order. We also need to filter repeating bookings against explicit records to remove duplicates there, because someone may explicitly request an instance an a recurring booking, so that all other instances should be suppressed.
SetRestriction(params ArchiveRestrictionInfo[])
Override: Extract and drop any restriction relating to Status, since that is handled here in the final filtering step
Declaration
public override bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)Parameters
| Type | Name | Description |
|---|---|---|
| ArchiveRestrictionInfo[] | restrictions |
Returns
| Type | Description |
|---|---|
| bool |
Overrides
Remarks
SimpleInvitationProviderResponseInvitationProviderCancelledInvitationProvider RepeatingInvitationProviderRejectedInvitationProviderExplicitInvitationProvider The final result set needs filtering to remove repeating records if we are running in "compressed" mode, and also reordering to make sure we get the right order. We also need to filter repeating bookings against explicit records to remove duplicates there, because someone may explicitly request an instance an a recurring booking, so that all other instances should be suppressed.