aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.BL/Serialization/ISerializableEntity.cs
blob: 80ac9604672a3674fb30eba80f66fbb07d8810b2 (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
34
35
36
37
38
39
40
41
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Tango.BL.Serialization
{
    /// <summary>
    /// Represents an object that defines which properties should not be serialized with the Json serializer.
    /// </summary>
    public interface ISerializableEntity
    {
        /// <summary>
        /// Gets the default serialization strategy.
        /// </summary>
        /// <param name="flags">The serialization flags.</param>
        /// <returns></returns>
        EntitySerializationStrategy GetDefaultSerializationStrategy(EntitySerializationFlags flags);

        /// <summary>
        /// Converts the entity to a json string using the specified serialization strategy.
        /// </summary>
        /// <param name="serializationStrategy">The serialization strategy.</param>
        /// <param name="flags">The flags.</param>
        /// <returns></returns>
        String ToJson(EntitySerializationStrategy serializationStrategy, EntitySerializationFlags flags);

        /// <summary>
        /// Converts the entity to a json string using the default serialization strategy.
        /// </summary>
        /// <returns></returns>
        String ToJson();

        /// <summary>
        /// Merges the specified json string into this entity.
        /// </summary>
        /// <param name="json">The json.</param>
        void PopulateFromJson(String json);
    }
}