mcs/class/System.Data.Linq/src/DbLinq/Data/Linq/Implementation/IEntityTracker.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;\r
  28 using System.Collections.Generic;\r
  29 using System.Linq;\r
  30 \r
  31 using DbLinq.Data.Linq.Identity;\r
  32 \r
  33 namespace DbLinq.Data.Linq.Implementation\r
  34 {\r
  35     /// <summary>\r
  36     /// Interface of Entity Trackers\r
  37     /// </summary>\r
  38     internal interface IEntityTracker\r
  39     {\r
  40         /// <summary>\r
  41         /// Finds entity by key (PK)\r
  42         /// </summary>\r
  43         /// <param name="identityKey"></param>\r
  44         /// <returns></returns>\r
  45         EntityTrack FindByIdentity(IdentityKey identityKey);\r
  46 \r
  47         /// <summary>\r
  48         /// Returns true if the list contains the entity\r
  49         /// </summary>\r
  50         /// <param name="entity"></param>\r
  51         /// <returns></returns>\r
  52         bool ContainsReference(object entity);\r
  53 \r
  54         /// <summary>\r
  55         /// Registers an entity to be inserted\r
  56         /// </summary>\r
  57         /// <param name="entity"></param>\r
  58         void RegisterToInsert(object entity);\r
  59 \r
  60         /// <summary>\r
  61         /// Registers an entity to be watched\r
  62         /// </summary>\r
  63         /// <param name="entity"></param>\r
  64         /// <param name="identityKey"></param>\r
  65         void RegisterToWatch(object entity, IdentityKey identityKey);\r
  66 \r
  67         /// <summary>\r
  68         /// Registers entity to be deleted\r
  69         /// </summary>\r
  70         /// <param name="entity"></param>\r
  71         void RegisterToDelete(object entity);\r
  72 \r
  73         /// <summary>\r
  74         /// Unregisters the entity after deletion\r
  75         /// </summary>\r
  76         /// <param name="entity"></param>\r
  77         void RegisterDeleted(object entity);\r
  78 \r
  79         /// <summary>\r
  80         /// Enumerates all registered entities\r
  81         /// </summary>\r
  82         /// <returns></returns>\r
  83         IEnumerable<EntityTrack> EnumerateAll();\r
  84     }\r
  85 }\r