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 System.Collections.Generic;
      11             : using Cqrs.Domain;
      12             : using Cqrs.Messages;
      13             : 
      14             : namespace Cqrs.Events
      15             : {
      16             :         /// <summary>
      17             :         /// Stores instances of <see cref="IEvent{TAuthenticationToken}"/> for replay, <see cref="IAggregateRoot{TAuthenticationToken}"/> and <see cref="ISaga{TAuthenticationToken}"/> rehydration.
      18             :         /// </summary>
      19             :         /// <typeparam name="TAuthenticationToken">The <see cref="Type"/> of the authentication token.</typeparam>
      20             :         public interface IEventStore<TAuthenticationToken>
      21             :         {
      22             :                 /// <summary>
      23             :                 /// Saves the provided <paramref name="event"/>.
      24             :                 /// </summary>
      25             :                 /// <typeparam name="T">The <see cref="Type"/> of the <see cref="IAggregateRoot{TAuthenticationToken}"/> the <see cref="IEvent{TAuthenticationToken}"/> was raised in.</typeparam>
      26             :                 /// <param name="event">The <see cref="IEvent{TAuthenticationToken}"/> to be saved.</param>
      27           1 :                 void Save<T>(IEvent<TAuthenticationToken> @event);
      28             : 
      29             :                 /// <summary>
      30             :                 /// Saves the provided <paramref name="event"/>.
      31             :                 /// </summary>
      32             :                 /// <param name="aggregateRootType"> <see cref="Type"/> of the <see cref="IAggregateRoot{TAuthenticationToken}"/> the <see cref="IEvent{TAuthenticationToken}"/> was raised in.</param>
      33             :                 /// <param name="event">The <see cref="IEvent{TAuthenticationToken}"/> to be saved.</param>
      34           2 :                 void Save(Type aggregateRootType, IEvent<TAuthenticationToken> @event);
      35             : 
      36             :                 /// <summary>
      37             :                 /// Gets a collection of <see cref="IEvent{TAuthenticationToken}"/> for the <typeparamref name="T">aggregate root</typeparamref> with the ID matching the provided <paramref name="aggregateId"/>.
      38             :                 /// </summary>
      39             :                 /// <typeparam name="T">The <see cref="Type"/> of the <see cref="IAggregateRoot{TAuthenticationToken}"/> the <see cref="IEvent{TAuthenticationToken}"/> was raised in.</typeparam>
      40             :                 /// <param name="aggregateId">The <see cref="IAggregateRoot{TAuthenticationToken}.Id"/> of the <see cref="IAggregateRoot{TAuthenticationToken}"/>.</param>
      41             :                 /// <param name="useLastEventOnly">Loads only the last event<see cref="IEvent{TAuthenticationToken}"/>.</param>
      42             :                 /// <param name="fromVersion">Load events starting from this version</param>
      43             :                 IEnumerable<IEvent<TAuthenticationToken>> Get<T>(Guid aggregateId, bool useLastEventOnly = false, int fromVersion = -1);
      44             : 
      45             :                 /// <summary>
      46             :                 /// Gets a collection of <see cref="IEvent{TAuthenticationToken}"/> for the <see cref="IAggregateRoot{TAuthenticationToken}"/> of type <paramref name="aggregateRootType"/> with the ID matching the provided <paramref name="aggregateId"/>.
      47             :                 /// </summary>
      48             :                 /// <param name="aggregateRootType"> <see cref="Type"/> of the <see cref="IAggregateRoot{TAuthenticationToken}"/> the <see cref="IEvent{TAuthenticationToken}"/> was raised in.</param>
      49             :                 /// <param name="aggregateId">The <see cref="IAggregateRoot{TAuthenticationToken}.Id"/> of the <see cref="IAggregateRoot{TAuthenticationToken}"/>.</param>
      50             :                 /// <param name="useLastEventOnly">Loads only the last event<see cref="IEvent{TAuthenticationToken}"/>.</param>
      51             :                 /// <param name="fromVersion">Load events starting from this version</param>
      52           1 :                 IEnumerable<IEvent<TAuthenticationToken>> Get(Type aggregateRootType, Guid aggregateId, bool useLastEventOnly = false, int fromVersion = -1);
      53             : 
      54             :                 /// <summary>
      55             :                 /// Get all <see cref="IEvent{TAuthenticationToken}"/> instances for the given <paramref name="correlationId"/>.
      56             :                 /// </summary>
      57             :                 /// <param name="correlationId">The <see cref="IMessage.CorrelationId"/> of the <see cref="IEvent{TAuthenticationToken}"/> instances to retrieve.</param>
      58           1 :                 IEnumerable<EventData> Get(Guid correlationId);
      59             :         }
      60             : }