Line data    Source code

       1             : #region Copyright
       2             : // // -----------------------------------------------------------------------
       3             : // // <copyright company="Chinchilla Software Limited">
       4             : // //   Copyright Chinchilla Software Limited. All rights reserved.
       5             : // // </copyright>
       6             : // // -----------------------------------------------------------------------
       7             : #endregion
       8             : 
       9             : using System;
      10             : using Cqrs.Domain;
      11             : 
      12             : namespace Cqrs.Snapshots
      13             : {
      14             :         /// <summary>
      15             :         /// Provides information about the ability to make and get <see cref="Snapshot">snapshots</see>.
      16             :         /// </summary>
      17             :         /// <typeparam name="TAuthenticationToken">The <see cref="Type"/> of the authentication token.</typeparam>
      18             :         public interface ISnapshotStrategy<TAuthenticationToken>
      19             :         {
      20             :                 /// <summary>
      21             :                 /// Indicates if the provided <paramref name="aggregate"/> should have a <see cref="Snapshot"/> made.
      22             :                 /// This does NOT indicate if the provided <paramref name="aggregate"/> can have a <see cref="Snapshot"/> made or not.
      23             :                 /// </summary>
      24             :                 /// <param name="aggregate">The <see cref="IAggregateRoot{TAuthenticationToken}"/> to check.</param>
      25           1 :                 bool ShouldMakeSnapShot(IAggregateRoot<TAuthenticationToken> aggregate);
      26             : 
      27             :                 /// <summary>
      28             :                 /// Indicates if the provided <paramref name="aggregateType"/> can have a <see cref="Snapshot"/> made or not.
      29             :                 /// </summary>
      30             :                 /// <param name="aggregateType">The <see cref="Type"/> of <see cref="IAggregateRoot{TAuthenticationToken}"/> to check.</param>
      31           1 :                 bool IsSnapshotable(Type aggregateType);
      32             :         }
      33             : }