mcs/class/System.Data.Linq/src/DbLinq/Data/Linq/IMemberModificationHandler.cs

   1 #region MIT license\r
   2 // \r
   3 // MIT license\r
   4 //\r
   5 // Copyright (c) 2007-2008 Jiri Moudry, Pascal Craponne\r
   6 // \r
   7 // Permission is hereby granted, free of charge, to any person obtaining a copy\r
   8 // of this software and associated documentation files (the "Software"), to deal\r
   9 // in the Software without restriction, including without limitation the rights\r
  10 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r
  11 // copies of the Software, and to permit persons to whom the Software is\r
  12 // furnished to do so, subject to the following conditions:\r
  13 // \r
  14 // The above copyright notice and this permission notice shall be included in\r
  15 // all copies or substantial portions of the Software.\r
  16 // \r
  17 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  18 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
  19 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
  20 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
  21 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
  22 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\r
  23 // THE SOFTWARE.\r
  24 // \r
  25 #endregion\r
  26 \r
  27 using System.Collections.Generic;\r
  28 using System.Data.Linq.Mapping;\r
  29 using System.Reflection;\r
  30 \r
  31 #if MONO_STRICT\r
  32 namespace System.Data.Linq\r
  33 #else\r
  34 namespace DbLinq.Data.Linq\r
  35 #endif\r
  36 {\r
  37     /// <summary>\r
  38     /// Interface to watch modifications on registered entities\r
  39     /// Currently supports:\r
  40     /// - IModified (kept for compatibility, not recommended since it does not allow partial updates)\r
  41     /// - INotifyPropertyChanging and INotifyPropertyChanged (best choice)\r
  42     /// - raw objects (keeps a copy of all entity data)\r
  43     /// </summary>\r
  44     internal interface IMemberModificationHandler\r
  45     {\r
  46         /// <summary>\r
  47         /// Start to watch an entity. From here, changes will make IsModified() return true\r
  48         /// </summary>\r
  49         /// <param name="entity"></param>\r
  50         /// <param name="metaModel"></param>\r
  51         void Register(object entity, MetaModel metaModel);\r
  52 \r
  53         /// <summary>\r
  54         /// Start to watch an entity. From here, changes will make IsModified() return true\r
  55         /// </summary>\r
  56         /// <param name="entity"></param>\r
  57         /// <param name="entityOriginalState"></param>\r
  58         /// <param name="metaModel"></param>\r
  59         void Register(object entity, object entityOriginalState, MetaModel metaModel);\r
  60 \r
  61         /// <summary>\r
  62         /// Returns if the entity was modified since it has been Register()ed for the first time\r
  63         /// </summary>\r
  64         /// <param name="entity"></param>\r
  65         /// <returns></returns>\r
  66         /// <param name="metaModel"></param>\r
  67         bool IsModified(object entity, MetaModel metaModel);\r
  68 \r
  69         /// <summary>\r
  70         /// Marks the entity as not dirty.\r
  71         /// </summary>\r
  72         /// <param name="entity"></param>\r
  73         /// <param name="metaModel"></param>\r
  74         void ClearModified(object entity, MetaModel metaModel);\r
  75 \r
  76         /// <summary>\r
  77         /// Returns a list of all modified properties since last Register/ClearModified\r
  78         /// </summary>\r
  79         /// <param name="entity"></param>\r
  80         /// <returns></returns>\r
  81         /// <param name="metaModel"></param>\r
  82         IList<MemberInfo> GetModifiedProperties(object entity, MetaModel metaModel);\r
  83 \r
  84         /// <summary>\r
  85         /// Unregisters an entity.\r
  86         /// This is useful when it is switched from update to delete list\r
  87         /// </summary>\r
  88         /// <param name="entity"></param>\r
  89         void Unregister(object entity);\r
  90     }\r
  91 }\r