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 System.Runtime.Serialization;
      12             : using Cqrs.Commands;
      13             : using Cqrs.Domain;
      14             : using Cqrs.Messages;
      15             : 
      16             : namespace Cqrs.Akka.Tests.Unit.Commands
      17             : {
      18             :         /// <summary>
      19             :         /// Instruct the system to update the Completed Conversation report.
      20             :         /// </summary>
      21             :         [Serializable]
      22             :         public class UpdateCompletedConversationReportCommand : ICommand<Guid>
      23           1 :         {
      24             :                 #region Implementation of IMessage
      25             : 
      26             :                 /// <summary>
      27             :                 /// An identifier used to group together several <see cref="IMessage"/>. Any <see cref="IMessage"/> with the same <see cref="CorrelationId"/> were triggered by the same initiating request.
      28             :                 /// </summary>
      29             :                 [DataMember]
      30             :                 public Guid CorrelationId { get; set; }
      31             : 
      32             :                 /// <summary>
      33             :                 /// The originating framework this message was sent from.
      34             :                 /// </summary>
      35             :                 [DataMember]
      36             :                 public string OriginatingFramework { get; set; }
      37             : 
      38             :                 /// <summary>
      39             :                 /// The frameworks this <see cref="IMessage"/> has been delivered to/sent via already.
      40             :                 /// </summary>
      41             :                 [DataMember]
      42             :                 public IEnumerable<string> Frameworks { get; set; }
      43             : 
      44             :                 #endregion
      45             : 
      46             :                 #region Implementation of IMessageWithAuthenticationToken<Guid>
      47             : 
      48             :                 /// <summary>
      49             :                 /// The authentication token of the entity that triggered the event to be raised.
      50             :                 /// </summary>
      51             :                 [DataMember]
      52             :                 public Guid AuthenticationToken { get; set; }
      53             : 
      54             :                 #endregion
      55             : 
      56             :                 #region Implementation of ICommand<Guid>
      57             : 
      58             :                 /// <summary>
      59             :                 /// The identifier of the command itself.
      60             :                 /// In some cases this may be the <see cref="IAggregateRoot{TAuthenticationToken}"/> or <see cref="ISaga{TAuthenticationToken}"/> this command targets.
      61             :                 /// </summary>
      62             :                 [DataMember]
      63             :                 public Guid Id { get; set; }
      64             : 
      65             :                 /// <summary>
      66             :                 /// The expected version number the targeted <see cref="IAggregateRoot{TAuthenticationToken}"/> or <see cref="ISaga{TAuthenticationToken}"/> is expected to be.
      67             :                 /// </summary>
      68             :                 [DataMember]
      69             :                 public int ExpectedVersion { get; set; }
      70             : 
      71             :                 #endregion
      72             :         }
      73             : }