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 namespace DbLinq.Data.Linq\r
  32 {\r
  33     /// <summary>\r
  34     /// Interface to watch modifications on registered entities\r
  35     /// Currently supports:\r
  36     /// - IModified (kept for compatibility, not recommended since it does not allow partial updates)\r
  37     /// - INotifyPropertyChanging and INotifyPropertyChanged (best choice)\r
  38     /// - raw objects (keeps a copy of all entity data)\r
  39     /// </summary>\r
  40     internal interface IMemberModificationHandler\r
  41     {\r
  42         /// <summary>\r
  43         /// Start to watch an entity. From here, changes will make IsModified() return true\r
  44         /// </summary>\r
  45         /// <param name="entity"></param>\r
  46         /// <param name="metaModel"></param>\r
  47         void Register(object entity, MetaModel metaModel);\r
  48 \r
  49         /// <summary>\r
  50         /// Start to watch an entity. From here, changes will make IsModified() return true\r
  51         /// </summary>\r
  52         /// <param name="entity"></param>\r
  53         /// <param name="entityOriginalState"></param>\r
  54         /// <param name="metaModel"></param>\r
  55         void Register(object entity, object entityOriginalState, MetaModel metaModel);\r
  56 \r
  57         /// <summary>\r
  58         /// Returns if the entity was modified since it has been Register()ed for the first time\r
  59         /// </summary>\r
  60         /// <param name="entity"></param>\r
  61         /// <returns></returns>\r
  62         /// <param name="metaModel"></param>\r
  63         bool IsModified(object entity, MetaModel metaModel);\r
  64 \r
  65         /// <summary>\r
  66         /// Marks the entity as not dirty.\r
  67         /// </summary>\r
  68         /// <param name="entity"></param>\r
  69         /// <param name="metaModel"></param>\r
  70         void ClearModified(object entity, MetaModel metaModel);\r
  71 \r
  72         /// <summary>\r
  73         /// Returns a list of all modified properties since last Register/ClearModified\r
  74         /// </summary>\r
  75         /// <param name="entity"></param>\r
  76         /// <returns></returns>\r
  77         /// <param name="metaModel"></param>\r
  78         IList<MemberInfo> GetModifiedProperties(object entity, MetaModel metaModel);\r
  79 \r
  80         /// <summary>\r
  81         /// Unregisters an entity.\r
  82         /// This is useful when it is switched from update to delete list\r
  83         /// </summary>\r
  84         /// <param name="entity"></param>\r
  85         void Unregister(object entity);\r
  86     }\r
  87 }\r