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.Runtime.Serialization;
      11             : 
      12             : namespace Cqrs.Services
      13             : {
      14             :         /// <summary>
      15             :         /// A response message envelope that holds request state and correlation information in response to using public API requests.
      16             :         /// </summary>
      17             :         [Serializable]
      18             :         [DataContract]
      19             :         public class ServiceResponse : IVersionedServiceResponse
      20           1 :         {
      21             :                 /// <summary>
      22             :                 /// Instantiate a new instance of the <see cref="ServiceResponse"/> class.
      23             :                 /// </summary>
      24           1 :                 public ServiceResponse()
      25             :                 {
      26             :                         State = ServiceResponseStateType.Succeeded;
      27             :                 }
      28             : 
      29             :                 #region Implementation of IServiceResponse
      30             : 
      31             :                 /// <summary>
      32             :                 /// The state of the request.
      33             :                 /// </summary>
      34             :                 [DataMember]
      35             :                 public ServiceResponseStateType State { get; set; }
      36             : 
      37             :                 /// <summary>
      38             :                 /// The correlation id used to group together events and notifications.
      39             :                 /// </summary>
      40             :                 [DataMember]
      41             :                 public Guid CorrelationId { get; set; }
      42             : 
      43             :                 #endregion
      44             : 
      45             :                 #region Implementation of IVersionedServiceResponse
      46             : 
      47             :                 /// <summary>
      48             :                 /// The version of the data being returned
      49             :                 /// </summary>
      50             :                 [DataMember]
      51             :                 public double Version { get; set; }
      52             : 
      53             :                 #endregion
      54             :         }
      55             : }