Class ActivityArchiveProviderBase

Base class for Activity archive providers. Activity archives can be found under the Company card, the Project card, and the Diary. These archives follow slightly different rules with regard to filtering along the axes of date, kind, repetition and booking type, as indicated by the ActivityArchiveKind parameter from the subclasses.

Inheritance
object
MultiQueryProviderBase
ActivityArchiveProviderBase
ActivityArchiveProvider
ContactActivityArchiveProvider
DiaryActivityArchiveProvider
PersonActivityArchiveProvider
ProjectActivityArchiveProvider
SaleActivityArchiveProvider
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
public abstract class ActivityArchiveProviderBase : MultiQueryProviderBase, IArchiveMultiQueryProvider, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities
Remarks

This provider accepts the row types 'appointment', 'todo' and 'document'. However, there is, in this provider, a relationship between entities and restrictions, as follows:

  • If the restriction 'appointmentId' is present, then the 'document' entity will be disabled
  • If the restriction 'documentId' is present, then the 'appointment' and 'todo' entities will be disabled
Disabled entities means simply that the provider behaves as if they were not specified in the SetDesiredEntities(params string[]) call, and no such rows will be returned. This functionality is fairly logical, and better than the default behaviour would have been: return appointment row as specified, and all document rows that match all the other criteria.

Constructors

ActivityArchiveProviderBase(ActivityArchiveKind, string)

Base class for Activity archive providers. Activity archives can be found under the Company card, the Project card, and the Diary. These archives follow slightly different rules with regard to filtering along the axes of date, kind, repetition and booking type, as indicated by the ActivityArchiveKind parameter from the subclasses.

Declaration
protected ActivityArchiveProviderBase(ActivityArchiveKind kind, string requiredNonZeroIdRestrictionName = null)
Parameters
Type Name Description
ActivityArchiveKind kind
string requiredNonZeroIdRestrictionName
Remarks

This provider accepts the row types 'appointment', 'todo' and 'document'. However, there is, in this provider, a relationship between entities and restrictions, as follows:

  • If the restriction 'appointmentId' is present, then the 'document' entity will be disabled
  • If the restriction 'documentId' is present, then the 'appointment' and 'todo' entities will be disabled
Disabled entities means simply that the provider behaves as if they were not specified in the SetDesiredEntities(params string[]) call, and no such rows will be returned. This functionality is fairly logical, and better than the default behaviour would have been: return appointment row as specified, and all document rows that match all the other criteria.

Fields

EntityAppointment

Base class for Activity archive providers. Activity archives can be found under the Company card, the Project card, and the Diary. These archives follow slightly different rules with regard to filtering along the axes of date, kind, repetition and booking type, as indicated by the ActivityArchiveKind parameter from the subclasses.

Declaration
public const string EntityAppointment = "appointment"
Field Value
Type Description
string
Remarks

This provider accepts the row types 'appointment', 'todo' and 'document'. However, there is, in this provider, a relationship between entities and restrictions, as follows:

  • If the restriction 'appointmentId' is present, then the 'document' entity will be disabled
  • If the restriction 'documentId' is present, then the 'appointment' and 'todo' entities will be disabled
Disabled entities means simply that the provider behaves as if they were not specified in the SetDesiredEntities(params string[]) call, and no such rows will be returned. This functionality is fairly logical, and better than the default behaviour would have been: return appointment row as specified, and all document rows that match all the other criteria.

EntityDocument

Base class for Activity archive providers. Activity archives can be found under the Company card, the Project card, and the Diary. These archives follow slightly different rules with regard to filtering along the axes of date, kind, repetition and booking type, as indicated by the ActivityArchiveKind parameter from the subclasses.

Declaration
public const string EntityDocument = "document"
Field Value
Type Description
string
Remarks

This provider accepts the row types 'appointment', 'todo' and 'document'. However, there is, in this provider, a relationship between entities and restrictions, as follows:

  • If the restriction 'appointmentId' is present, then the 'document' entity will be disabled
  • If the restriction 'documentId' is present, then the 'appointment' and 'todo' entities will be disabled
Disabled entities means simply that the provider behaves as if they were not specified in the SetDesiredEntities(params string[]) call, and no such rows will be returned. This functionality is fairly logical, and better than the default behaviour would have been: return appointment row as specified, and all document rows that match all the other criteria.

EntityMailing

Base class for Activity archive providers. Activity archives can be found under the Company card, the Project card, and the Diary. These archives follow slightly different rules with regard to filtering along the axes of date, kind, repetition and booking type, as indicated by the ActivityArchiveKind parameter from the subclasses.

Declaration
public const string EntityMailing = "mailing"
Field Value
Type Description
string
Remarks

This provider accepts the row types 'appointment', 'todo' and 'document'. However, there is, in this provider, a relationship between entities and restrictions, as follows:

  • If the restriction 'appointmentId' is present, then the 'document' entity will be disabled
  • If the restriction 'documentId' is present, then the 'appointment' and 'todo' entities will be disabled
Disabled entities means simply that the provider behaves as if they were not specified in the SetDesiredEntities(params string[]) call, and no such rows will be returned. This functionality is fairly logical, and better than the default behaviour would have been: return appointment row as specified, and all document rows that match all the other criteria.

EntityOther

Base class for Activity archive providers. Activity archives can be found under the Company card, the Project card, and the Diary. These archives follow slightly different rules with regard to filtering along the axes of date, kind, repetition and booking type, as indicated by the ActivityArchiveKind parameter from the subclasses.

Declaration
public const string EntityOther = "other"
Field Value
Type Description
string
Remarks

This provider accepts the row types 'appointment', 'todo' and 'document'. However, there is, in this provider, a relationship between entities and restrictions, as follows:

  • If the restriction 'appointmentId' is present, then the 'document' entity will be disabled
  • If the restriction 'documentId' is present, then the 'appointment' and 'todo' entities will be disabled
Disabled entities means simply that the provider behaves as if they were not specified in the SetDesiredEntities(params string[]) call, and no such rows will be returned. This functionality is fairly logical, and better than the default behaviour would have been: return appointment row as specified, and all document rows that match all the other criteria.

EntityToDo

Base class for Activity archive providers. Activity archives can be found under the Company card, the Project card, and the Diary. These archives follow slightly different rules with regard to filtering along the axes of date, kind, repetition and booking type, as indicated by the ActivityArchiveKind parameter from the subclasses.

Declaration
public const string EntityToDo = "todo"
Field Value
Type Description
string
Remarks

This provider accepts the row types 'appointment', 'todo' and 'document'. However, there is, in this provider, a relationship between entities and restrictions, as follows:

  • If the restriction 'appointmentId' is present, then the 'document' entity will be disabled
  • If the restriction 'documentId' is present, then the 'appointment' and 'todo' entities will be disabled
Disabled entities means simply that the provider behaves as if they were not specified in the SetDesiredEntities(params string[]) call, and no such rows will be returned. This functionality is fairly logical, and better than the default behaviour would have been: return appointment row as specified, and all document rows that match all the other criteria.

IconCommon

Base class for Activity archive providers. Activity archives can be found under the Company card, the Project card, and the Diary. These archives follow slightly different rules with regard to filtering along the axes of date, kind, repetition and booking type, as indicated by the ActivityArchiveKind parameter from the subclasses.

Declaration
public const string IconCommon = "Activity"
Field Value
Type Description
string
Remarks

This provider accepts the row types 'appointment', 'todo' and 'document'. However, there is, in this provider, a relationship between entities and restrictions, as follows:

  • If the restriction 'appointmentId' is present, then the 'document' entity will be disabled
  • If the restriction 'documentId' is present, then the 'appointment' and 'todo' entities will be disabled
Disabled entities means simply that the provider behaves as if they were not specified in the SetDesiredEntities(params string[]) call, and no such rows will be returned. This functionality is fairly logical, and better than the default behaviour would have been: return appointment row as specified, and all document rows that match all the other criteria.

Methods

GetRowsAsync(string, CancellationToken)

Override: remove the Retired (always) and Expired (if preference says so) style hints

Declaration
public override IAsyncEnumerable<ArchiveRow> GetRowsAsync(string options, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string options
CancellationToken cancellationToken
Returns
Type Description
IAsyncEnumerable<ArchiveRow>
Overrides
Remarks

This provider accepts the row types 'appointment', 'todo' and 'document'. However, there is, in this provider, a relationship between entities and restrictions, as follows:

  • If the restriction 'appointmentId' is present, then the 'document' entity will be disabled
  • If the restriction 'documentId' is present, then the 'appointment' and 'todo' entities will be disabled
Disabled entities means simply that the provider behaves as if they were not specified in the SetDesiredEntities(params string[]) call, and no such rows will be returned. This functionality is fairly logical, and better than the default behaviour would have been: return appointment row as specified, and all document rows that match all the other criteria.

SetDesiredEntities(params string[])

Override: Intercept and store desired entities; they will be set on base class from the GetRows method to take possible disabled entities into account

Declaration
public override void SetDesiredEntities(params string[] entities)
Parameters
Type Name Description
string[] entities
Overrides
Remarks

This provider accepts the row types 'appointment', 'todo' and 'document'. However, there is, in this provider, a relationship between entities and restrictions, as follows:

  • If the restriction 'appointmentId' is present, then the 'document' entity will be disabled
  • If the restriction 'documentId' is present, then the 'appointment' and 'todo' entities will be disabled
Disabled entities means simply that the provider behaves as if they were not specified in the SetDesiredEntities(params string[]) call, and no such rows will be returned. This functionality is fairly logical, and better than the default behaviour would have been: return appointment row as specified, and all document rows that match all the other criteria.

SetRestriction(ArchiveRestrictionInfo[])

Override: track restrictions to see if appointmentId or documentId has been set

Declaration
public override bool SetRestriction(ArchiveRestrictionInfo[] restrictions)
Parameters
Type Name Description
ArchiveRestrictionInfo[] restrictions
Returns
Type Description
bool
Overrides
Remarks

This provider accepts the row types 'appointment', 'todo' and 'document'. However, there is, in this provider, a relationship between entities and restrictions, as follows:

  • If the restriction 'appointmentId' is present, then the 'document' entity will be disabled
  • If the restriction 'documentId' is present, then the 'appointment' and 'todo' entities will be disabled
Disabled entities means simply that the provider behaves as if they were not specified in the SetDesiredEntities(params string[]) call, and no such rows will be returned. This functionality is fairly logical, and better than the default behaviour would have been: return appointment row as specified, and all document rows that match all the other criteria.

Implements

Extension Methods