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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
|
//---------------------------------------------------------------------
// <copyright file="DataObject.cs" company="Microsoft">
// Copyright (c) Microsoft Corporation. All rights reserved.
// </copyright>
//
// @owner [....]
// @backupOwner [....]
//---------------------------------------------------------------------
using System.Data;
using System.Diagnostics;
using System.Globalization;
using System.Reflection;
using System.ComponentModel;
using System.Runtime.Serialization;
using System.Data.Common.Utils;
namespace System.Data.Objects.DataClasses
{
/// <summary>
/// This class contains the common methods need for an date object.
/// </summary>
[DataContract(IsReference = true)]
[Serializable]
public abstract class StructuralObject : INotifyPropertyChanging, INotifyPropertyChanged
{
// ------
// Fields
// ------
// This class contains no fields that are serialized, but it's important to realize that
// adding or removing a serialized field is considered a breaking change. This includes
// changing the field type or field name of existing serialized fields. If you need to make
// this kind of change, it may be possible, but it will require some custom
// serialization/deserialization code.
/// <summary>
/// Public constant name used for change tracking
/// Providing this definition allows users to use this constant instead of
/// hard-coding the string. This helps to ensure the property name is correct
/// and allows faster comparisons in places where we are looking for this specific string.
/// Users can still use the case-sensitive string directly instead of the constant,
/// it will just be slightly slower on comparison.
/// Including the dash (-) character around the name ensures that this will not conflict with
/// a real data property, because -EntityKey- is not a valid identifier name
/// </summary>
public static readonly string EntityKeyPropertyName = "-EntityKey-";
#region INotifyPropertyChanged Members
/// <summary>
/// Notification that a property has been changed.
/// </summary>
/// <remarks>
/// The PropertyChanged event can indicate all properties on the
/// object have changed by using either a null reference
/// (Nothing in Visual Basic) or String.Empty as the property name
/// in the PropertyChangedEventArgs.
/// </remarks>
[field: NonSerialized]
public event PropertyChangedEventHandler PropertyChanged;
#endregion
#region INotifyPropertyChanging Members
/// <summary>
/// Notification that a property is about to be changed.
/// </summary>
/// <remarks>
/// The PropertyChanging event can indicate all properties on the
/// object are changing by using either a null reference
/// (Nothing in Visual Basic) or String.Empty as the property name
/// in the PropertyChangingEventArgs.
/// </remarks>
[field: NonSerialized]
public event PropertyChangingEventHandler PropertyChanging;
#endregion
#region Protected Overrideable
/// <summary>
/// Invokes the PropertyChanged event.
/// </summary>
/// <param name="property">
/// The string name of the of the changed property.
/// </param>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Property")]
protected virtual void OnPropertyChanged(string property)
{
if (PropertyChanged != null)
{
PropertyChanged.Invoke(this, new PropertyChangedEventArgs(property));
}
}
/// <summary>
/// Invokes the PropertyChanging event.
/// </summary>
/// <param name="property">
/// The string name of the of the changing property.
/// </param>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Property")]
protected virtual void OnPropertyChanging(string property)
{
if (PropertyChanging != null)
{
PropertyChanging.Invoke(this, new PropertyChangingEventArgs(property));
}
}
#endregion
#region Protected Helper
/// <summary>
/// The minimum DateTime value allowed in the store
/// </summary>
/// <value>
/// The minimum DateTime value allowed in the store
/// </value>
protected static DateTime DefaultDateTimeValue()
{
return DateTime.Now;
}
/// <summary>
/// This method is called whenever a change is going to be made to an object
/// property's value.
/// </summary>
/// <param name="property">
/// The name of the changing property.
/// </param>
/// <param name="value">
/// The current value of the property.
/// </param>
/// <exception cref="System.ArgumentNullException">
/// When parameter member is null (Nothing in Visual Basic).
/// </exception>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Property")]
protected virtual void ReportPropertyChanging(
string property)
{
EntityUtil.CheckStringArgument(property, "property");
OnPropertyChanging(property);
}
/// <summary>
/// This method is called whenever a change is made to an object
/// property's value.
/// </summary>
/// <param name="property">
/// The name for the changed property.
/// </param>
/// <exception cref="System.ArgumentNullException">
/// When parameter member is null (Nothing in Visual Basic).
/// </exception>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Property")]
protected virtual void ReportPropertyChanged(
string property)
{
EntityUtil.CheckStringArgument(property, "property");
OnPropertyChanged(property);
}
/// <summary>
/// Lazily creates a complex type if the current value is null
/// </summary>
/// <remarks>
/// Unlike most of the other helper methods in this class, this one is not static
/// because it references the SetValidValue for complex objects, which is also not static
/// because it needs a reference to this.
/// </remarks>
/// <typeparam name="T">
/// Type of complex type to get a valid value for
/// </typeparam>
/// <param name="currentValue">
/// The current value of the complex type property
/// </param>
/// <param name="property">
/// The name of the property that is calling this method
/// </param>
/// <param name="isInitialized">
/// True if the field has already been explicitly set by the user.
/// </param>
/// <returns>
/// The new value of the complex type property
/// </returns>
protected internal T GetValidValue<T>(T currentValue, string property, bool isNullable, bool isInitialized) where T : ComplexObject, new()
{
// If we support complex type inheritance we will also need to check if T is abstract
if (!isNullable && !isInitialized)
{
currentValue = SetValidValue(currentValue, new T(), property);
}
return currentValue;
}
/// <summary>
/// This method is called by a ComplexObject contained in this Entity
/// whenever a change is about to be made to a property of the
/// ComplexObject so that the change can be forwarded to the change tracker.
/// </summary>
/// <param name="entityMemberName">
/// The name of the top-level entity property that contains the ComplexObject that is calling this method.
/// </param>
/// <param name="complexObject">
/// The instance of the ComplexObject on which the property is changing.
/// </param>
/// <param name="complexMemberName">
/// The name of the changing property on complexObject.
/// </param>
internal abstract void ReportComplexPropertyChanging(
string entityMemberName, ComplexObject complexObject, string complexMemberName);
/// <summary>
/// This method is called by a ComplexObject contained in this Entity
/// whenever a change has been made to a property of the
/// ComplexObject so that the change can be forwarded to the change tracker.
/// </summary>
/// <param name="entityMemberName">
/// The name of the top-level entity property that contains the ComplexObject that is calling this method.
/// </param>
/// <param name="complexObject">
/// The instance of the ComplexObject on which the property is changing.
/// </param>
/// <param name="complexMemberName">
/// The name of the changing property on complexObject.
/// </param>
internal abstract void ReportComplexPropertyChanged(
string entityMemberName, ComplexObject complexObject, string complexMemberName);
/// <summary>
/// Determines whether the structural object is attached to a change tracker or not
/// </summary>
internal abstract bool IsChangeTracked { get; }
/// <summary>
/// Determines whether the specified byte arrays contain identical values
/// </summary>
/// <param name="first">The first byte array value to compare</param>
/// <param name="second">The second byte array value to compare</param>
/// <returns>
/// <c>true</c> if both arrays are <c>null</c>, or if both arrays are of
/// the same length and contain the same byte values; otherwise <c>false</c>.
/// </returns>
protected internal static bool BinaryEquals(byte[] first, byte[] second)
{
if (object.ReferenceEquals(first, second))
{
return true;
}
if (first == null || second == null)
{
return false;
}
return ByValueEqualityComparer.CompareBinaryValues(first, second);
}
/// <summary>
/// Duplicates the current byte value.
/// </summary>
/// <param name="currentValue">
/// The current byte array value
/// </param>
/// <returns>
/// Must return a copy of the values because byte arrays are mutable without providing a
/// reliable mechanism for us to track changes. This allows us to treat byte arrays like
/// structs which is at least a somewhat understood mechanism.
/// </returns>
protected internal static byte[] GetValidValue(byte[] currentValue)
{
if (currentValue == null)
{
return null;
}
return (byte[])currentValue.Clone();
}
/// <summary>
/// Makes sure the Byte [] value being set for a property is valid.
/// </summary>
/// <param name="value">
/// The value passed into the property setter.
/// </param>
/// <param name="isNullable">
/// Flag indicating if this property is allowed to be null.
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// Returns the value if valid.
/// </returns>
/// <exception cref="System.Data.ConstraintException">
/// If value is null for a non nullable value.
/// </exception>
protected internal static Byte[] SetValidValue(Byte[] value, bool isNullable, string propertyName)
{
if (value == null)
{
if (!isNullable)
{
EntityUtil.ThrowPropertyIsNotNullable(propertyName);
}
return value;
}
return (byte[])value.Clone();
}
/// <summary>
/// Makes sure the Byte [] value being set for a property is valid.
/// </summary>
/// <param name="value">
/// The value passed into the property setter.
/// </param>
/// <param name="isNullable">
/// Flag indicating if this property is allowed to be null.
/// </param>
/// <returns>
/// Returns the value if valid.
/// </returns>
/// <exception cref="System.Data.ConstraintException">
/// If value is null for a non nullable value.
/// </exception>
protected internal static Byte[] SetValidValue(Byte[] value, bool isNullable)
{
return SetValidValue(value, isNullable, null);
}
/// <summary>
/// Makes sure the boolean value being set for a property is valid.
/// </summary>
/// <param name="value">
/// Boolean value.
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The Boolean value.
/// </returns>
protected internal static bool SetValidValue(bool value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the boolean value being set for a property is valid.
/// </summary>
/// <param name="value">
/// Boolean value.
/// </param>
/// <returns>
/// The Boolean value.
/// </returns>
protected internal static bool SetValidValue(bool value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the boolean value being set for a property is valid.
/// </summary>
/// <param name="value">
/// Boolean value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The Boolean value.
/// </returns>
protected internal static Nullable<bool> SetValidValue(Nullable<bool> value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the boolean value being set for a property is valid.
/// </summary>
/// <param name="value">
/// Boolean value
/// </param>
/// <returns>
/// The Boolean value.
/// </returns>
protected internal static Nullable<bool> SetValidValue(Nullable<bool> value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the byte value being set for a property is valid.
/// </summary>
/// <param name="value">
/// Byte value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The Byte value.
/// </returns>
protected internal static byte SetValidValue(byte value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the byte value being set for a property is valid.
/// </summary>
/// <param name="value">
/// Byte value
/// </param>
/// <returns>
/// The Byte value.
/// </returns>
protected internal static byte SetValidValue(byte value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the byte value being set for a property is valid.
/// </summary>
/// <param name="value">
/// Byte value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The Byte value.
/// </returns>
protected internal static Nullable<byte> SetValidValue(Nullable<byte> value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the byte value being set for a property is valid.
/// </summary>
/// <param name="value">
/// Byte value
/// </param>
/// <returns>
/// The Byte value.
/// </returns>
protected internal static Nullable<byte> SetValidValue(Nullable<byte> value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the sbyte value being set for a property is valid.
/// </summary>
/// <param name="value">
/// sbyte value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The sbyte value.
/// </returns>
[CLSCompliant(false)]
protected internal static sbyte SetValidValue(sbyte value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the sbyte value being set for a property is valid.
/// </summary>
/// <param name="value">
/// sbyte value
/// </param>
/// <returns>
/// The sbyte value.
/// </returns>
[CLSCompliant(false)]
protected internal static sbyte SetValidValue(sbyte value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the sbyte value being set for a property is valid.
/// </summary>
/// <param name="value">
/// sbyte value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The sbyte value.
/// </returns>
[CLSCompliant(false)]
protected internal static Nullable<sbyte> SetValidValue(Nullable<sbyte> value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the sbyte value being set for a property is valid.
/// </summary>
/// <param name="value">
/// sbyte value
/// </param>
/// <returns>
/// The sbyte value.
/// </returns>
[CLSCompliant(false)]
protected internal static Nullable<sbyte> SetValidValue(Nullable<sbyte> value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the datetime value being set for a property is valid.
/// </summary>
/// <param name="value">
/// datetime value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The datetime value.
/// </returns>
protected internal static DateTime SetValidValue(DateTime value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the datetime value being set for a property is valid.
/// </summary>
/// <param name="value">
/// datetime value
/// </param>
/// <returns>
/// The datetime value.
/// </returns>
protected internal static DateTime SetValidValue(DateTime value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the datetime value being set for a property is valid.
/// </summary>
/// <param name="value">
/// datetime value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The datetime value.
/// </returns>
protected internal static Nullable<DateTime> SetValidValue(Nullable<DateTime> value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the datetime value being set for a property is valid.
/// </summary>
/// <param name="value">
/// datetime value
/// </param>
/// <returns>
/// The datetime value.
/// </returns>
protected internal static Nullable<DateTime> SetValidValue(Nullable<DateTime> value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the timespan value being set for a property is valid.
/// </summary>
/// <param name="value">
/// timespan value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The timspan value.
/// </returns>
protected internal static TimeSpan SetValidValue(TimeSpan value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the timespan value being set for a property is valid.
/// </summary>
/// <param name="value">
/// timespan value
/// </param>
/// <returns>
/// The timspan value.
/// </returns>
protected internal static TimeSpan SetValidValue(TimeSpan value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the TimeSpan value being set for a property is valid.
/// </summary>
/// <param name="value">
/// timespan value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The timespan value.
/// </returns>
protected internal static Nullable<TimeSpan> SetValidValue(Nullable<TimeSpan> value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the TimeSpan value being set for a property is valid.
/// </summary>
/// <param name="value">
/// timespan value
/// </param>
/// <returns>
/// The timespan value.
/// </returns>
protected internal static Nullable<TimeSpan> SetValidValue(Nullable<TimeSpan> value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the datetimeoffset value being set for a property is valid.
/// </summary>
/// <param name="value">
/// datetimeoffset value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The datetimeoffset value.
/// </returns>
protected internal static DateTimeOffset SetValidValue(DateTimeOffset value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the datetimeoffset value being set for a property is valid.
/// </summary>
/// <param name="value">
/// datetimeoffset value
/// </param>
/// <returns>
/// The datetimeoffset value.
/// </returns>
protected internal static DateTimeOffset SetValidValue(DateTimeOffset value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the datetimeoffset value being set for a property is valid.
/// </summary>
/// <param name="value">
/// datetimeoffset value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The datetimeoffset value.
/// </returns>
protected internal static Nullable<DateTimeOffset> SetValidValue(Nullable<DateTimeOffset> value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the datetimeoffset value being set for a property is valid.
/// </summary>
/// <param name="value">
/// datetimeoffset value
/// </param>
/// <returns>
/// The datetimeoffset value.
/// </returns>
protected internal static Nullable<DateTimeOffset> SetValidValue(Nullable<DateTimeOffset> value)
{
// no checks yet
return value;
}
/// <summary>
/// Ensure that the input is a valid decimal value
/// </summary>
/// <param name="value">
/// decimal value.
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The decimal value.
/// </returns>
protected internal static Decimal SetValidValue(Decimal value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Ensure that the input is a valid decimal value
/// </summary>
/// <param name="value">
/// proposed value
/// </param>
/// <returns>new value</returns>
protected internal static Decimal SetValidValue(Decimal value)
{
// no checks yet
return value;
}
/// <summary>
/// Ensure that the input is a valid decimal value
/// </summary>
/// <param name="value">
/// decimal value.
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The decimal value.
/// </returns>
protected internal static Nullable<Decimal> SetValidValue(Nullable<Decimal> value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Ensure that the input is a valid decimal value
/// </summary>
/// <param name="value">
/// decimal value.
/// </param>
/// <returns>
/// The decimal value.
/// </returns>
protected internal static Nullable<Decimal> SetValidValue(Nullable<Decimal> value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the double value being set for a property is valid.
/// </summary>
/// <param name="value">
/// double value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// the double value
/// </returns>
protected internal static double SetValidValue(double value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the double value being set for a property is valid.
/// </summary>
/// <param name="value">
/// double value
/// </param>
/// <returns>
/// the double value
/// </returns>
protected internal static double SetValidValue(double value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the double value being set for a property is valid.
/// </summary>
/// <param name="value">
/// double value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// the double value
/// </returns>
protected internal static Nullable<double> SetValidValue(Nullable<double> value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the double value being set for a property is valid.
/// </summary>
/// <param name="value">
/// double value
/// </param>
/// <returns>
/// the double value
/// </returns>
protected internal static Nullable<double> SetValidValue(Nullable<double> value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Single value being set for a property is valid.
/// </summary>
/// <param name="value">
/// float value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// the float value.
/// </returns>
protected internal static float SetValidValue(Single value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Single value being set for a property is valid.
/// </summary>
/// <param name="value">
/// float value
/// </param>
/// <returns>
/// the float value.
/// </returns>
protected internal static float SetValidValue(Single value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Single value being set for a property is valid.
/// </summary>
/// <param name="value">
/// nullable Single value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// the nullable Single value
/// </returns>
protected internal static Nullable<Single> SetValidValue(Nullable<Single> value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Single value being set for a property is valid.
/// </summary>
/// <param name="value">
/// nullable Single value
/// </param>
/// <returns>
/// the nullable Single value
/// </returns>
protected internal static Nullable<Single> SetValidValue(Nullable<Single> value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Guid value being set for a property is valid.
/// </summary>
/// <param name="value">
/// Guid value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The Guid value
/// </returns>
protected internal static Guid SetValidValue(Guid value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Guid value being set for a property is valid.
/// </summary>
/// <param name="value">
/// Guid value
/// </param>
/// <returns>
/// The Guid value
/// </returns>
protected internal static Guid SetValidValue(Guid value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Guid value being set for a property is valid.
/// </summary>
/// <param name="value">
/// nullable Guid value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The nullable Guid value
/// </returns>
protected internal static Nullable<Guid> SetValidValue(Nullable<Guid> value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Guid value being set for a property is valid.
/// </summary>
/// <param name="value">
/// nullable Guid value
/// </param>
/// <returns>
/// The nullable Guid value
/// </returns>
protected internal static Nullable<Guid> SetValidValue(Nullable<Guid> value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Int16 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// Int16 value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The Int16 value
/// </returns>
protected internal static Int16 SetValidValue(Int16 value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Int16 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// Int16 value
/// </param>
/// <returns>
/// The Int16 value
/// </returns>
protected internal static Int16 SetValidValue(Int16 value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Int16 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// nullable Int16
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The Int16 value
/// </returns>
protected internal static Nullable<Int16> SetValidValue(Nullable<Int16> value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Int16 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// nullable Int16
/// </param>
/// <returns>
/// The Int16 value
/// </returns>
protected internal static Nullable<Int16> SetValidValue(Nullable<Int16> value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Int32 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// Int32 value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The Int32 value
/// </returns>
protected internal static Int32 SetValidValue(Int32 value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Int32 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// Int32 value
/// </param>
/// <returns>
/// The Int32 value
/// </returns>
protected internal static Int32 SetValidValue(Int32 value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Int32 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// nullable Int32 value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The nullable Int32</returns>
protected internal static Nullable<Int32> SetValidValue(Nullable<Int32> value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Int32 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// nullable Int32 value
/// </param>
/// <returns>
/// The nullable Int32</returns>
protected internal static Nullable<Int32> SetValidValue(Nullable<Int32> value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Int64 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// Int64 value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The Int64 value
/// </returns>
protected internal static Int64 SetValidValue(Int64 value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Int64 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// Int64 value
/// </param>
/// <returns>
/// The Int64 value
/// </returns>
protected internal static Int64 SetValidValue(Int64 value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Int64 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// nullable Int64 value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The nullable Int64 value
/// </returns>
protected internal static Nullable<Int64> SetValidValue(Nullable<Int64> value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the Int64 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// nullable Int64 value
/// </param>
/// <returns>
/// The nullable Int64 value
/// </returns>
protected internal static Nullable<Int64> SetValidValue(Nullable<Int64> value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the UInt16 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// UInt16 value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The UInt16 value
/// </returns>
[CLSCompliant(false)]
protected internal static UInt16 SetValidValue(UInt16 value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the UInt16 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// UInt16 value
/// </param>
/// <returns>
/// The UInt16 value
/// </returns>
[CLSCompliant(false)]
protected internal static UInt16 SetValidValue(UInt16 value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the UInt16 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// nullable UInt16 value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The nullable UInt16 value
/// </returns>
[CLSCompliant(false)]
protected internal static Nullable<UInt16> SetValidValue(Nullable<UInt16> value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the UInt16 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// nullable UInt16 value
/// </param>
/// <returns>
/// The nullable UInt16 value
/// </returns>
[CLSCompliant(false)]
protected internal static Nullable<UInt16> SetValidValue(Nullable<UInt16> value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the UInt32 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// UInt32 value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The UInt32 value
/// </returns>
[CLSCompliant(false)]
protected internal static UInt32 SetValidValue(UInt32 value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the UInt32 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// UInt32 value
/// </param>
/// <returns>
/// The UInt32 value
/// </returns>
[CLSCompliant(false)]
protected internal static UInt32 SetValidValue(UInt32 value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the UInt32 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// nullable UInt32 value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The nullable UInt32 value
/// </returns>
[CLSCompliant(false)]
protected internal static Nullable<UInt32> SetValidValue(Nullable<UInt32> value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the UInt32 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// nullable UInt32 value
/// </param>
/// <returns>
/// The nullable UInt32 value
/// </returns>
[CLSCompliant(false)]
protected internal static Nullable<UInt32> SetValidValue(Nullable<UInt32> value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the UInt64 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// UInt64 value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The UInt64 value
/// </returns>
[CLSCompliant(false)]
protected internal static UInt64 SetValidValue(UInt64 value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the UInt64 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// UInt64 value
/// </param>
/// <returns>
/// The UInt64 value
/// </returns>
[CLSCompliant(false)]
protected internal static UInt64 SetValidValue(UInt64 value)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the UInt64 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// nullable UInt64 value
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <returns>
/// The nullable UInt64 value
/// </returns>
[CLSCompliant(false)]
protected internal static Nullable<UInt64> SetValidValue(Nullable<UInt64> value, string propertyName)
{
// no checks yet
return value;
}
/// <summary>
/// Makes sure the UInt64 value being set for a property is valid.
/// </summary>
/// <param name="value">
/// nullable UInt64 value
/// </param>
/// <returns>
/// The nullable UInt64 value
/// </returns>
[CLSCompliant(false)]
protected internal static Nullable<UInt64> SetValidValue(Nullable<UInt64> value)
{
// no checks yet
return value;
}
/// <summary>
/// Validates that the property is not longer than allowed, and throws if it is
/// </summary>
/// <param name="value">
/// string value to be checked.
/// </param>
/// <param name="isNullable">
/// Flag indicating if this property is allowed to be null.
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <exception cref="System.Data.ConstraintException">
/// The string value is null for a non-nullable string
/// </exception>
protected internal static string SetValidValue(string value, bool isNullable, string propertyName)
{
if (value == null)
{
if (!isNullable)
{
EntityUtil.ThrowPropertyIsNotNullable(propertyName);
}
}
return value;
}
/// <summary>
/// Validates that the property is not longer than allowed, and throws if it is
/// </summary>
/// <param name="value">
/// string value to be checked.
/// </param>
/// <param name="isNullable">
/// Flag indicating if this property is allowed to be null.
/// </param>
/// <exception cref="System.Data.ConstraintException">
/// The string value is null for a non-nullable string
/// </exception>
protected internal static string SetValidValue(string value, bool isNullable)
{
return SetValidValue(value, isNullable, null);
}
/// <summary>
/// Validates that the property is not null, and throws if it is
/// </summary>
/// <param name="value">
/// <see cref="System.Data.Spatial.DbGeography"/> value to be checked.
/// </param>
/// <param name="isNullable">
/// Flag indicating if this property is allowed to be null.
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <exception cref="System.Data.ConstraintException">
/// The value is null for a non-nullable property
/// </exception>
protected internal static System.Data.Spatial.DbGeography SetValidValue(System.Data.Spatial.DbGeography value, bool isNullable, string propertyName)
{
if (value == null)
{
if (!isNullable)
{
EntityUtil.ThrowPropertyIsNotNullable(propertyName);
}
}
return value;
}
/// <summary>
/// Validates that the property is not null, and throws if it is
/// </summary>
/// <param name="value">
/// <see cref="System.Data.Spatial.DbGeography"/> value to be checked.
/// </param>
/// <param name="isNullable">
/// Flag indicating if this property is allowed to be null.
/// </param>
/// <exception cref="System.Data.ConstraintException">
/// The value is null for a non-nullable property
/// </exception>
protected internal static System.Data.Spatial.DbGeography SetValidValue(System.Data.Spatial.DbGeography value, bool isNullable)
{
return SetValidValue(value, isNullable, null);
}
/// <summary>
/// Validates that the property is not null, and throws if it is
/// </summary>
/// <param name="value">
/// <see cref="System.Data.Spatial.DbGeometry"/> value to be checked.
/// </param>
/// <param name="isNullable">
/// Flag indicating if this property is allowed to be null.
/// </param>
/// <param name="propertyName">
/// Name of the property that is being validated.
/// </param>
/// <exception cref="System.Data.ConstraintException">
/// The value is null for a non-nullable property
/// </exception>
protected internal static System.Data.Spatial.DbGeometry SetValidValue(System.Data.Spatial.DbGeometry value, bool isNullable, string propertyName)
{
if (value == null)
{
if (!isNullable)
{
EntityUtil.ThrowPropertyIsNotNullable(propertyName);
}
}
return value;
}
/// <summary>
/// Validates that the property is not null, and throws if it is
/// </summary>
/// <param name="value">
/// <see cref="System.Data.Spatial.DbGeometry"/> value to be checked.
/// </param>
/// <param name="isNullable">
/// Flag indicating if this property is allowed to be null.
/// </param>
/// <exception cref="System.Data.ConstraintException">
/// The value is null for a non-nullable property
/// </exception>
protected internal static System.Data.Spatial.DbGeometry SetValidValue(System.Data.Spatial.DbGeometry value, bool isNullable)
{
return SetValidValue(value, isNullable, null);
}
/// <summary>
/// Set a whole ComplexObject on an Entity or another ComplexObject
/// </summary>
/// <remarks>
/// Unlike most of the other SetValidValue methods, this one is not static
/// because it uses a reference to this in order to set the parent reference for the complex object.
/// </remarks>
/// <param name="oldValue">
/// The current value that is set.
/// </param>
/// <param name="newValue">
/// The new value that will be set.
/// </param>
/// <param name="property">
/// The name of the complex type property that is being set.
/// </param>
/// <returns>
/// The new value of the complex type property
/// </returns>
protected internal T SetValidValue<T>(T oldValue, T newValue, string property) where T : ComplexObject
{
// Nullable complex types are not supported in v1, but we allow setting null here if the parent entity is detached
if (newValue == null && IsChangeTracked)
{
throw EntityUtil.NullableComplexTypesNotSupported(property);
}
if (oldValue != null)
{
oldValue.DetachFromParent();
}
if (newValue != null)
{
newValue.AttachToParent(this, property);
}
return newValue;
}
/// <summary>
/// Helper method used in entity/complex object factory methods to verify that a complex object is not null
/// </summary>
/// <typeparam name="TComplex">Type of the complex property</typeparam>
/// <param name="complexObject">Complex object being verified</param>
/// <param name="propertyName">Property name associated with this complex object</param>
/// <returns>the same complex object that was passed in, if an exception didn't occur</returns>
protected internal static TComplex VerifyComplexObjectIsNotNull<TComplex>(TComplex complexObject, string propertyName) where TComplex : ComplexObject
{
if (complexObject == null)
{
EntityUtil.ThrowPropertyIsNotNullable(propertyName);
}
return complexObject;
}
#endregion
}
}
|