第一章(1):Nettiers实体层,IEntity,EntityState

 

1.         /// <summary>
2.     /// List of possible state for an entity.
3.     /// </summary>
4.     ///实体状态定义
5.         public enum EntityState
6.     {
7.         /// <summary>
8.         /// Entity is unchanged
9.         /// </summary>
10.         Unchanged=0,
12.         /// <summary>
13.         /// Entity is new
14.         /// </summary>
15.         Added=1,
17.         /// <summary>
18.         /// Entity has been modified
19.         /// </summary>
20.         Changed=2,
22.         /// <summary>
23.         /// Entity has been deleted
24.         /// </summary>
25.         Deleted=3
26.     }
28.         /// <summary>
29.         /// The interface that each business object of the model implements.
30.         /// </summary>
31.         public interface IEntity
32.         {
33.                 /// <summary>
34.                 ///        The name of the underlying database table.表名
35.                 /// </summary>
36.                 string TableName { get;}
38.                 /// <summary>
39.                 ///        Indicates if the object has been modified from its original state.
40.                 /// </summary>
41.                 ///<value>True if object has been modified from its original state; otherwise False;</value>
42.                 ///实体改变时为TRUE,否则为假
43.                 bool IsDirty {get;}
45.                 /// <summary>
46.                 ///        Indicates if the object is new.
47.                 /// </summary>
48.                 ///<value>True if objectis new; otherwise False;</value>
49.                 ///实体为新建时为TRUE
50.                 bool IsNew {get;}
52.                 /// <summary>
53.                 /// True if object has been marked as deleted. ReadOnly.
54.                 /// </summary>
55.                 ///实体标记为DELETED时为TRUE
56.                 bool IsDeleted {get;}
58.                 /// <summary>
59.                 /// Indicates if the object is in a valid state
60.                 /// </summary>
61.                 /// <value>True if object is valid; otherwise False.</value>
62.                 ///校验有效时为TRUE
63.                 bool IsValid { get;}
65.                 /// <summary>
66.                 /// Returns one of EntityState enum values - intended to replace IsNew, IsDirty, IsDeleted.
67.                 /// </summary>
68.                 //返回实体状态
69.                 EntityState EntityState {get;}
71.                 /// <summary>
72.                 /// Accepts the changes made to this object by setting each flags to false.
73.                 /// </summary>
74.                 ///当手动实现保存方法后,通过acceptchange方法来修改对象的属性,状态改为未修改，还将副本清除
75.                 void AcceptChanges();
77.                 /// <summary>
78.                 /// Marks entity to be deleted.
79.                 /// </summary>
80.                 ///标记实体为删除
81.                 void MarkToDelete();
83.                 /// <summary>
84.         /// Gets or sets the parent collection.
85.         /// </summary>
86.         /// <value>The parent collection.</value>
87.         ///取父实体
88.                 object ParentCollection{get;set;}
90.                 /// <summary>
91.                 ///                The name of the underlying database table's columns.
92.                 /// </summary>
93.                 /// <value>A string array that holds the columns names.</value>
94.                 ///取列名数组
95.                 string[] TableColumns {get;}
98.                 /// <summary>
99.                 ///     Gets or sets the object that contains supplemental data about this object.
100.                 /// </summary>
101.                 /// <value>Object</value>
102.                 ///实体的摘要内容
103.                 object Tag { get;set;}
105.                 /// <summary>
106.       /// Event to indicate that a property has changed.
107.       /// </summary>
108.       ///实体属性改变事件
109.                 event PropertyChangedEventHandler PropertyChanged;
111.                 /// <summary>
112.                 /// Determines whether this entity is being tracked.
113.                 /// </summary>
114.                 bool IsEntityTracked {        get;  set;        }
116.                 ///<summary>
117.                 /// The tracking key used to with the <see cref="EntityLocator" />
118.                 ///</summary>
119.                 string EntityTrackingKey {        get;  set;  }
120.         }
122.         /// <summary>
123.         ///     Interface that TList and every entity implements to support
124.         ///                cloning of an object tree.
125.         /// </summary>
126.         ///克隆扩展接口
127.         public interface ICloneableEx
128.         {
129.                 ///<summary>
130.                 /// The tracking key used to with the <see cref="EntityLocator" />
131.                 ///</summary>
132.                 ///<param name="existingCopies">A list containing references to all objects already copied.</param>
133.                 object Clone(IDictionary existingCopies);
134.         }