aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.BL/ActionLogs/IActionLogComparable.cs
blob: 255f5a4070cd92982e4dbf801067f0c85bf6f3ef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Tango.BL.ValueObjects;

namespace Tango.BL.ActionLogs
{
    /// <summary>
    /// Represents a type which is supported for ActionLog difference comparison.
    /// </summary>
    public interface IActionLogComparable
    {
        /// <summary>
        /// Gets the unique identifier of the object.
        /// </summary>
        String Guid { get; }

        /// <summary>
        /// Returns true if the specified property should be ignored during ActionLog comparison.
        /// </summary>
        /// <param name="propName">Name of the property.</param>
        /// <returns></returns>
        bool ShouldActionLogIgnore(String propName);

        /// <summary>
        /// Returns an optional custom name for this instance in the comparison tree.
        /// </summary>
        /// <returns></returns>
        String GetActionLogName();
    }
}