forked from SAP/odata-vocabularies
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Common.xml
1430 lines (1303 loc) · 90.5 KB
/
Common.xml
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
<?xml version="1.0" encoding="utf-8"?>
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
<edmx:Reference Uri="https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Core.V1.xml">
<edmx:Include Alias="Core" Namespace="Org.OData.Core.V1" />
</edmx:Reference>
<edmx:Reference Uri="https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Validation.V1.xml">
<edmx:Include Alias="Validation" Namespace="Org.OData.Validation.V1" />
</edmx:Reference>
<edmx:Reference Uri="https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Aggregation.V1.xml">
<edmx:Include Alias="Aggregation" Namespace="Org.OData.Aggregation.V1" />
</edmx:Reference>
<edmx:Reference Uri="https://sap.github.io/odata-vocabularies/vocabularies/UI.xml">
<edmx:Include Namespace="com.sap.vocabularies.UI.v1" Alias="UI" />
</edmx:Reference>
<edmx:Reference Uri="https://sap.github.io/odata-vocabularies/vocabularies/Analytics.xml">
<edmx:Include Namespace="com.sap.vocabularies.Analytics.v1" Alias="Analytics" />
</edmx:Reference>
<edmx:DataServices>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="com.sap.vocabularies.Common.v1" Alias="Common">
<Annotation Term="Core.Description">
<String>Common terms for all SAP vocabularies</String>
</Annotation>
<Annotation Term="Core.Description" Qualifier="Published">
<String>2017-02-15 © Copyright 2013 SAP SE. All rights reserved.</String>
</Annotation>
<Annotation Term="Core.Links">
<Collection>
<Record>
<PropertyValue Property="rel" String="latest-version" />
<PropertyValue Property="href" String="https://sap.github.io/odata-vocabularies/vocabularies/Common.xml" />
</Record>
<Record>
<PropertyValue Property="rel" String="alternate" />
<PropertyValue Property="href" String="https://sap.github.io/odata-vocabularies/vocabularies/Common.json" />
</Record>
<Record>
<PropertyValue Property="rel" String="describedby" />
<PropertyValue Property="href" String="https://github.com/sap/odata-vocabularies/blob/main/vocabularies/Common.md" />
</Record>
</Collection>
</Annotation>
<Term Name="Experimental" Type="Edm.String" Nullable="true">
<!-- can be used without value -->
<Annotation Term="Core.Description">
<String>Terms, types, and properties annotated with this term are experimental and can be changed incompatibly or removed completely any time without prior warning.</String>
</Annotation>
<Annotation Term="Core.LongDescription">
<String>Do not use or rely on experimental terms, types, and properties in production environments.</String>
</Annotation>
</Term>
<!-- Section: Versioning -->
<Term Name="ServiceVersion" Type="Edm.Int32" Nullable="false" AppliesTo="Schema">
<Annotation Term="Core.Description" String="1 for first version of a service, incremented when schema changes incompatibly and service is published with a different URI" />
</Term>
<Term Name="ServiceSchemaVersion" Type="Edm.Int32" Nullable="false" AppliesTo="Schema">
<Annotation Term="Core.Description" String="0 for first schema version within a service version, incremented when schema changes compatibly" />
</Term>
<!-- Section: General Semantics -->
<Term Name="Label" Type="Edm.String" Nullable="false">
<Annotation Term="Core.Description" String="A short, human-readable text suitable for labels and captions in UIs" />
<Annotation Term="Core.IsLanguageDependent" />
</Term>
<Term Name="Heading" Type="Edm.String" Nullable="false">
<Annotation Term="Core.Description" String="A short, human-readable text suitable for column headings in UIs" />
<Annotation Term="Core.IsLanguageDependent" />
</Term>
<Term Name="QuickInfo" Type="Edm.String" Nullable="false">
<Annotation Term="Core.Description" String="A short, human-readable text suitable for tool tips in UIs" />
<Annotation Term="Core.IsLanguageDependent" />
</Term>
<Term Name="Text" Type="Edm.String" Nullable="true" AppliesTo="Property">
<Annotation Term="Core.Description" String="A descriptive text for values of the annotated property. Value MUST be a dynamic expression when used as metadata annotation." />
<Annotation Term="Core.IsLanguageDependent" />
</Term>
<Term Name="TextFor" Type="Edm.PropertyPath" Nullable="false" AppliesTo="Property">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Core.Description" String="The annotated property contains a descriptive text for values of the referenced property." />
</Term>
<Term Name="ExternalID" Type="Edm.String" Nullable="true" AppliesTo="Property">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="A human readable identifier for values of the annotated property. Value MUST be a dynamic expression when used as metadata annotation." />
<Annotation Term="Core.LongDescription" String="If the annotated property is (part of) a foreign key of a resource, the external id is a human readable (part of an) identifier of this resource. There is a one-to-one relationship between each possible value of the annotated property and the corresponding external id." />
</Term>
<!--
<Term Name="ExternalIDs" Type="Collection(Edm.String)" Nullable="true" AppliesTo="Property">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="A list of parts of a human readable identifier for values of the annotated property. Value MUST be a dynamic expression when used as metadata annotation." />
<Annotation Term="Core.LongDescription" String="If the annotated property is (part of) a foreign key of a resource, the collection of external ids constitutes a human readable (part of an) identifier of this resource. There is a one-to-one relationship between each possible value of the annotated property and the corresponding collection of external ids." />
</Term>
-->
<Term Name="IsLanguageIdentifier" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="An identifier to distinguish multiple texts in different languages for the same entity" />
</Term>
<Term Name="TextFormat" Type="Common.TextFormatType" Nullable="false" AppliesTo="Property Parameter ReturnType">
<Annotation Term="Core.Description" String="The annotated property, parameter, or return type contains human-readable text that may contain formatting information" />
<Annotation Term="Core.RequiresType" String="Edm.String" />
</Term>
<EnumType Name="TextFormatType">
<Member Name="plain">
<Annotation Term="Core.Description" String="Plain text, line breaks represented as the character 0x0A" />
</Member>
<Member Name="html">
<Annotation Term="Core.Description" String="Plain text with markup that can validly appear directly within an HTML DIV element" />
</Member>
</EnumType>
<Term Name="Timezone" Type="Edm.String" Nullable="true" AppliesTo="Property Parameter">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="The point in time represented by the annotated property or parameter shall be interpreted in the given time zone" />
<Annotation Term="Core.LongDescription">
<String>Time zones shall be specified according to the [IANA](https://www.iana.org/time-zones) standard.
If this annotation is absent or null or an empty string, points in time are typically interpreted in the current user's or default time zone.
The annotation value can be a path expression resolving to a property that may be tagged with [`IsTimezone`](#IsTimezone).</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.DateTimeOffset" />
</Term>
<Term Name="IsTimezone" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property Parameter">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="Annotated property or parameter is a time zone" />
</Term>
<!-- under discussion
<Term Name="ValidationConstraint" Type="Common.ValidationConstraintType" Nullable="false" AppliesTo="Property EntityType ComplexType">
<Annotation Term="Core.Description" String="Condition that the annotation target has to fulfill" />
</Term>
<ComplexType Name="ValidationConstraintType">
<Property Name="FailureMessage" Type="Edm.String" Nullable="true">
<Annotation Term="Core.IsLanguageDependent" />
</Property>
<Property Name="Condition" Type="Edm.Boolean" Nullable="false">
<Annotation Term="Core.Description"
String="Value MUST be a dynamic expression that evaluates to true if and only if the constraint is fulfilled" />
</Property>
</ComplexType>
-->
<!-- Examples:
<Annotation Term="Common.ValidationConstraint" Qualifier="Comparison">
<Record>
<PropertyValue Property="FailureMessage" String="Start date cannot be after end date" />
<PropertyValue Property="Condition">
<Le>
<Path>StartDate</Path>
<Path>EndDate</Path>
</Le>
</PropertyValue>
</Record>
</Annotation>
<Annotation Term="Common.ValidationConstraint" Qualifier="Minimum">
<Record>
<PropertyValue Property="FailureMessage" String="Value cannot be negative" />
<PropertyValue Property="Condition">
<Ge>
<Path>Amount</Path>
<Decimal>0</Decimal>
</Ge>
</PropertyValue>
</Record>
</Annotation>
-->
<!--
could later be combined with a client-side function sap.matchRegularExpression
Two arguments of type string, second argument MUST evaluate to a JavaScript regular expression, see e.g.
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
Function returns true if and only if the whole first argument matches the regular expression in the second argumentReturns
-->
<Term Name="IsDigitSequence" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property Parameter">
<Annotation Term="Core.Description" String="Contains only digits" />
<Annotation Term="Core.RequiresType" String="Edm.String" />
</Term>
<Term Name="IsUpperCase" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property Parameter">
<Annotation Term="Core.Description" String="Contains just uppercase characters" />
<Annotation Term="Core.RequiresType" String="Edm.String" />
</Term>
<Term Name="IsCurrency" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property Parameter">
<Annotation Term="Core.Description" String="Annotated property or parameter is a currency code" />
</Term>
<Term Name="IsUnit" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property Parameter">
<Annotation Term="Core.Description" String="Annotated property or parameter is a unit of measure" />
</Term>
<Term Name="UnitSpecificScale" Type="Edm.PrimitiveType" Nullable="false" AppliesTo="Property">
<Annotation Term="Core.Description" String="The number of fractional decimal digits of a currency amount or measured quantity" />
<Annotation Term="Core.LongDescription" String="The annotated property contains a currency code or unit of measure, and the annotation value specifies the default scale of numeric values with that currency code or unit of measure. Can be used in e.g. a list of available currency codes or units of measure, or a list of measuring devices to specify the number of fractional digits captured by that device." />
</Term>
<Term Name="UnitSpecificPrecision" Type="Edm.PrimitiveType" Nullable="false" AppliesTo="Property">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="The number of significant decimal digits of a currency amount or measured quantity" />
<Annotation Term="Core.LongDescription" String="The annotated property contains a currency code or unit of measure, and the annotation value specifies the default precision of numeric values with that currency code or unit of measure. Can be used in e.g. a list of available currency codes or units of measure, or a list of measuring devices to specify the number of significant digits captured by that device." />
</Term>
<Term Name="SecondaryKey" AppliesTo="EntityType" Type="Collection(Edm.PropertyPath)" Nullable="false">
<Annotation Term="Core.Revisions">
<Collection>
<Record>
<PropertyValue Property="Kind" EnumMember="Core.RevisionKind/Deprecated" />
<PropertyValue Property="Description" String="Use term `AlternateKeys` from the OASIS Core vocabulary instead" />
</Record>
</Collection>
</Annotation>
<Annotation Term="Core.Description" String="The listed properties form a secondary key. Multiple secondary keys are possible using different qualifiers." />
</Term>
<Term Name="MinOccurs" AppliesTo="NavigationProperty Property EntitySet Term Parameter" Type="Edm.Int64" Nullable="false">
<Annotation Term="Core.Description" String="The annotated set or collection contains at least this number of items" />
</Term>
<Term Name="MaxOccurs" AppliesTo="NavigationProperty Property EntitySet Term Parameter" Type="Edm.Int64" Nullable="false">
<Annotation Term="Core.Description" String="The annotated set or collection contains at most this number of items" />
</Term>
<Term Name="AssociationEntity" Type="Collection(Edm.NavigationPropertyPath)" Nullable="false" AppliesTo="EntityType">
<Annotation Term="Core.Description">
<String>Entity representing an n:m association with attributes</String>
</Annotation>
<Annotation Term="Common.MinOccurs" Int="2" />
</Term>
<Term Name="DerivedNavigation" Type="Edm.NavigationPropertyPath" Nullable="false" AppliesTo="NavigationProperty">
<Annotation Term="Core.Description">
<String>Shortcut for a multi-segment navigation, contains the long path with all its segments</String>
</Annotation>
</Term>
<Term Name="Masked" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Revisions">
<Annotation Term="Common.Experimental" />
<Collection>
<Record>
<PropertyValue Property="Kind" EnumMember="Core.RevisionKind/Deprecated" />
<PropertyValue Property="Description" String="Use terms `MaskedValue` instead" />
</Record>
</Collection>
</Annotation>
<Annotation Term="Core.Description">
<String>Property contains sensitive data that should by default be masked on a UI and clear-text visible only upon user interaction</String>
</Annotation>
</Term>
<Term Name="MaskedValue" Type="Edm.String" Nullable="true" AppliesTo="Property">
<Annotation Term="Common.Experimental" />
<Annotation Term="Common.IsInstanceAnnotation" />
<Annotation Term="Core.Description" String="Property contains sensitive data that is by default not transferred" />
<Annotation Term="Core.LongDescription">
<String>By default a masked property is excluded from responses and instead an instance annotation with this term is sent, containing a masked value that can be rendered by user interfaces.</String>
</Annotation>
</Term>
<Term Name="RevealOnDemand" Type="Edm.Boolean" Nullable="false" AppliesTo="Property">
<Annotation Term="Common.Experimental" />
<Annotation Term="Common.IsInstanceAnnotation" />
<Annotation Term="Core.Description" String="Unmasked data for this property can be requested with custom query option `masked-values=false`" />
</Term>
<Term Name="SemanticObject" Type="Edm.String" Nullable="true" AppliesTo="EntitySet EntityType Property NavigationProperty">
<Annotation Term="Core.Description" String="Name of the Semantic Object represented as this entity type or identified by this property" />
</Term>
<Term Name="SemanticObjectMapping" BaseTerm="Common.SemanticObject" Type="Collection(Common.SemanticObjectMappingType)" Nullable="false" AppliesTo="EntitySet EntityType Property">
<Annotation Term="Core.Description" String="Maps properties of the annotated entity type or sibling properties of the annotated property to properties of the Semantic Object" />
<Annotation Term="Core.LongDescription" String="This allows "renaming" of properties in the current context to match property names of the Semantic Object, e.g. `SenderPartyID` to `PartyID`. Only properties explicitly listed in the mapping are renamed, all other properties are available for intent-based navigation with their "local" name." />
</Term>
<ComplexType Name="SemanticObjectMappingType">
<Annotation Term="Core.Description" String="Maps a property of the annotated entity type or a sibling property of the annotated property to a property of the Semantic Object" />
<Property Name="LocalProperty" Type="Edm.PropertyPath" Nullable="false">
<Annotation Term="Core.Description" String="Path to a local property that provides the value for the Semantic Object property" />
</Property>
<Property Name="SemanticObjectProperty" Type="Edm.String" Nullable="false">
<Annotation Term="Core.Description" String="Name of the Semantic Object property" />
</Property>
</ComplexType>
<Term Name="SemanticObjectUnavailableActions" BaseTerm="Common.SemanticObject" Type="Collection(Edm.String)" Nullable="false" AppliesTo="EntitySet EntityType Property">
<Annotation Term="Core.Description" String="List of actions that are not available in the current state of the instance of the Semantic Object" />
</Term>
<Term Name="IsInstanceAnnotation" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Term">
<Annotation Term="Core.Description" String="Term can also be used as instance annotation; AppliesTo of this term specifies where it can be applied" />
</Term>
<!-- use Capabilities instead
<Term Name="Insertable" Type="Edm.Boolean" Nullable="false" DefaultValue="true" AppliesTo="NavigationProperty">
<Annotation Term="Common.Experimental" />
<Annotation Term="Common.IsInstanceAnnotation" />
<Annotation Term="Core.Description">
<String>Specifies whether the service allows to create an entity by sending a POST request to the navigation link URL (in this case the created entity is automatically linked to the entity containing the navigation link)</String>
</Annotation>
</Term>
<Term Name="Updatable" Type="Edm.Boolean" Nullable="false" DefaultValue="true" AppliesTo="EntityType">
<Annotation Term="Common.Experimental" />
<Annotation Term="Common.IsInstanceAnnotation" />
<Annotation Term="Core.Description">
<String>Specifies whether the annotated entity can be updated</String>
</Annotation>
</Term>
<Term Name="Deletable" Type="Edm.Boolean" Nullable="false" DefaultValue="true" AppliesTo="EntityType">
<Annotation Term="Common.Experimental" />
<Annotation Term="Common.IsInstanceAnnotation" />
<Annotation Term="Core.Description">
<String>Specifies whether the annotated entity can be deleted</String>
</Annotation>
</Term>
-->
<Term Name="FilterExpressionRestrictions" Type="Collection(Common.FilterExpressionRestrictionType)" Nullable="false" AppliesTo="EntitySet">
<Annotation Term="Core.Description" String="These properties only allow a subset of expressions" />
<Annotation Term="Core.Revisions">
<Collection>
<Record>
<PropertyValue Property="Kind" EnumMember="Core.RevisionKind/Deprecated" />
<PropertyValue Property="Description" String="Use term Capabilities.FilterRestrictions instead" />
</Record>
</Collection>
</Annotation>
</Term>
<ComplexType Name="FilterExpressionRestrictionType">
<Annotation Term="Core.Revisions">
<Collection>
<Record>
<PropertyValue Property="Kind" EnumMember="Core.RevisionKind/Deprecated" />
<PropertyValue Property="Description" String="Use term Capabilities.FilterRestrictions instead" />
</Record>
</Collection>
</Annotation>
<Property Name="Property" Type="Edm.PropertyPath" />
<Property Name="AllowedExpressions" Type="Common.FilterExpressionType" />
</ComplexType>
<EnumType Name="FilterExpressionType">
<Annotation Term="Core.Revisions">
<Collection>
<Record>
<PropertyValue Property="Kind" EnumMember="Core.RevisionKind/Deprecated" />
<PropertyValue Property="Description" String="Use term Capabilities.FilterRestrictions instead" />
</Record>
</Collection>
</Annotation>
<Member Name="SingleValue">
<Annotation Term="Core.Description" String="a single 'eq' clause" />
</Member>
<Member Name="MultiValue">
<Annotation Term="Core.Description" String="one or more 'eq' clauses, separated by 'or'" />
</Member>
<Member Name="SingleInterval">
<Annotation Term="Core.Description" String="at most one 'ge' and one 'le' clause, separated by 'and', alternatively a single 'eq' clause" />
</Member>
</EnumType>
<Term Name="FieldControl" Type="Common.FieldControlType" DefaultValue="Optional" AppliesTo="Property Parameter Record EntityType">
<Annotation Term="Core.Description" String="Control state of a property, parameter, or the media stream of a media entity" />
<Annotation Term="Core.LongDescription" String="This term can be used for static field control, providing an enumeration member value in $metadata, as well as dynamically, providing a `Path` expression.

In the dynamic case the property referenced by the `Path` expression MUST be of type `Edm.Byte` to accommodate OData V2 services as well as V4 infrastructures that don't support enumeration types." />
<Annotation Term="Common.IsInstanceAnnotation" />
</Term>
<EnumType Name="FieldControlType" UnderlyingType="Edm.Byte">
<Annotation Term="Core.Description" String="Control state of a property" />
<Member Name="Mandatory" Value="7">
<Annotation Term="Core.Description" String="Property is mandatory from a business perspective" />
<Annotation Term="Core.LongDescription" String="This annotation value does not imply any restrictions on the value range of the property. For restricting the value range use e.g. the standard type facet `Nullable` with a value of `false` to exclude the `null` value, or terms from the [Validation vocabulary](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Validation.V1.md)." />
</Member>
<Member Name="Optional" Value="3">
<Annotation Term="Core.Description" String="Property may have a value" />
<Annotation Term="Core.LongDescription" String="This value does not make sense as a static annotation value." />
</Member>
<Member Name="ReadOnly" Value="1">
<Annotation Term="Core.Description" String="Property value cannot be changed" />
<Annotation Term="Core.LongDescription" String="To statically mark a property as read-only use term [Core.Computed](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Computed) instead" />
</Member>
<Member Name="Inapplicable" Value="0">
<Annotation Term="Core.Description" String="Property has no meaning in the current entity state" />
<Annotation Term="Core.LongDescription">
<String>This value does not make sense as a static annotation value.
Example for dynamic use: in a travel expense report the property `DestinationCountry` is inapplicable if trip type is domestic, and mandatory if trip type is international.</String>
</Annotation>
</Member>
<Member Name="Hidden" Value="0">
<Annotation Term="Core.Description" String="Deprecated synonymn for Inapplicable, do not use" />
<Annotation Term="Core.LongDescription" String="To statically hide a property on a UI use [UI.Hidden](UI.md#Hidden) instead" />
</Member>
</EnumType>
<Term Name="ExceptionCategory" Type="Edm.String" Nullable="false">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="A machine-readable exception category" />
<Annotation Term="Common.IsInstanceAnnotation" />
</Term>
<Term Name="Application" Type="Common.ApplicationType" Nullable="false">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="..." />
<Annotation Term="Common.IsInstanceAnnotation" />
</Term>
<ComplexType Name="ApplicationType">
<Annotation Term="Common.Experimental" />
<Property Name="Component" Type="Edm.String">
<Annotation Term="Core.Description" String="Software component of service implementation" />
</Property>
<Property Name="ServiceRepository" Type="Edm.String">
<Annotation Term="Core.Description" String="..." />
</Property>
<Property Name="ServiceId" Type="Edm.String">
<Annotation Term="Core.Description" String="..." />
</Property>
<Property Name="ServiceVersion" Type="Edm.String">
<Annotation Term="Core.Description" String="..." />
</Property>
</ComplexType>
<Term Name="Timestamp" Type="Edm.DateTimeOffset" Nullable="false">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="..." />
<Annotation Term="Common.IsInstanceAnnotation" />
</Term>
<Term Name="TransactionId" Type="Edm.String" Nullable="false">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="..." />
<Annotation Term="Common.IsInstanceAnnotation" />
</Term>
<Term Name="ErrorResolution" Type="Common.ErrorResolutionType" Nullable="false">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="Hints for resolving this error" />
<Annotation Term="Common.IsInstanceAnnotation" />
</Term>
<ComplexType Name="ErrorResolutionType">
<Annotation Term="Common.Experimental" />
<Property Name="Analysis" Type="Edm.String">
<Annotation Term="Core.Description" String="Short hint on how to analyze this error" />
</Property>
<Property Name="Note" Type="Edm.String">
<Annotation Term="Core.Description" String="Note for error resolution" />
</Property>
<Property Name="AdditionalNote" Type="Edm.String">
<Annotation Term="Core.Description" String="Additional note for error resolution" />
</Property>
</ComplexType>
<Term Name="Messages" Type="Collection(Edm.ComplexType)" Nullable="false">
<Annotation Term="Core.Description" String="Collection of end-user messages" />
<Annotation Term="Core.LongDescription">
<String>The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.
The minimum structure is
- `code: Edm.String`
- `message: Edm.String`
- `target: Edm.String nullable`
- `additionalTargets: Collection(Edm.String)`
- `transition: Edm.Boolean`
- `numericSeverity: Edm.Byte`
- `longtextUrl: Edm.String nullable`
</String>
</Annotation>
</Term>
<Term Name="additionalTargets" Type="Collection(Edm.String)" Nullable="false" AppliesTo="Record">
<Annotation Term="Common.Experimental" />
<Annotation Term="Common.IsInstanceAnnotation" />
<Annotation Term="Core.Description" String="Additional targets for the message" />
<Annotation Term="Core.LongDescription" String="This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response" />
</Term>
<Term Name="longtextUrl" Type="Edm.String" Nullable="false" AppliesTo="Record">
<Annotation Term="Core.IsURL" />
<Annotation Term="Common.IsInstanceAnnotation" />
<Annotation Term="Core.Description" String="Location of the message long text" />
<Annotation Term="Core.LongDescription" String="This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response" />
</Term>
<Term Name="numericSeverity" Type="Common.NumericMessageSeverityType" Nullable="false">
<Annotation Term="Common.IsInstanceAnnotation" />
<Annotation Term="Core.Description" String="Classifies an end-user message as info, success, warning, or error" />
<Annotation Term="Core.LongDescription" String="This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response" />
</Term>
<Term Name="MaximumNumericMessageSeverity" Type="Common.NumericMessageSeverityType" BaseTerm="Common.Messages" Nullable="true" AppliesTo="EntityType">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="The maximum severity of all end-user messages attached to an entity, null if no messages are attached" />
<Annotation Term="Core.LongDescription" String="This metadata annotation can be applied to entity types that are also annotated with term [`Common.Messages`](#Messages)" />
</Term>
<TypeDefinition Name="NumericMessageSeverityType" UnderlyingType="Edm.Byte">
<Annotation Term="Core.Description" String="Classifies an end-user message as info, success, warning, or error" />
<Annotation Term="Validation.AllowedValues">
<Collection>
<Record>
<PropertyValue Property="Value" Int="1" />
<Annotation Term="Core.Description" String="Success - no action required" />
</Record>
<Record>
<PropertyValue Property="Value" Int="2" />
<Annotation Term="Core.Description" String="Information - no action required" />
</Record>
<Record>
<PropertyValue Property="Value" Int="3" />
<Annotation Term="Core.Description" String="Warning - action may be required" />
</Record>
<Record>
<PropertyValue Property="Value" Int="4" />
<Annotation Term="Core.Description" String="Error - action is required" />
</Record>
</Collection>
</Annotation>
</TypeDefinition>
<Term Name="IsActionCritical" Type="Edm.Boolean" Nullable="false" DefaultValue="true" AppliesTo="Action Function ActionImport FunctionImport">
<Annotation Term="Core.Description" String="Criticality of the function or action to enforce a warning or similar before it's executed" />
</Term>
<Term Name="Attributes" Type="Collection(Edm.PropertyPath)" Nullable="false" AppliesTo="Property">
<Annotation Term="Core.Description" String="Attributes related to this property, which may occur in denormalized entity types" />
</Term>
<Term Name="RelatedRecursiveHierarchy" Type="Edm.AnnotationPath" Nullable="false" AppliesTo="Property">
<Annotation Term="Core.Description" String="A recursive hierarchy related to this property. The annotation path must end in Aggregation.RecursiveHierarchy." />
</Term>
<Term Name="Interval" Type="Common.IntervalType" Nullable="false" AppliesTo="EntityType ComplexType">
<Annotation Term="Core.Description" String="An interval with lower and upper boundaries described by two properties" />
</Term>
<ComplexType Name="IntervalType">
<Property Name="LowerBoundary" Type="Edm.PropertyPath" Nullable="false">
<Annotation Term="Core.Description" String="Property holding the lower interval boundary" />
</Property>
<Property Name="LowerBoundaryIncluded" Type="Edm.Boolean" Nullable="false" DefaultValue="true">
<Annotation Term="Core.Description" String="The lower boundary value is included in the interval" />
</Property>
<Property Name="UpperBoundary" Type="Edm.PropertyPath" Nullable="false">
<Annotation Term="Core.Description" String="Property holding the upper interval boundary" />
</Property>
<Property Name="UpperBoundaryIncluded" Type="Edm.Boolean" Nullable="false" DefaultValue="true">
<Annotation Term="Core.Description" String="The upper boundary value is included in the interval" />
</Property>
</ComplexType>
<Term Name="ResultContext" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="EntityType">
<Annotation Term="Core.Description">
<String>The annotated entity type has one or more containment navigation properties.
An instance of the annotated entity type provides the context required for determining
the target entity sets reached by these containment navigation properties.</String>
</Annotation>
</Term>
<Term Name="SAPObjectNodeType" Type="Common.SAPObjectNodeTypeType" Nullable="false" AppliesTo="EntityType">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="The SAP Object Node Type represented by the annotated entity type" />
<Annotation Term="Core.LongDescription">
<String>SAP Object Node Types define the structure of SAP Object Types, which are a generalization of Business Object, Technical Object, Configuration Object, and Analytical Object.</String>
</Annotation>
</Term>
<ComplexType Name="SAPObjectNodeTypeType">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="Information about an SAP Object Node Type" />
<Property Name="Name" Type="Edm.String" Nullable="false">
<Annotation Term="Core.Description" String="The name of the SAP Object Node Type" />
</Property>
</ComplexType>
<Term Name="Composition" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="NavigationProperty">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="The annotated navigation property represents a logical composition, even though it is non-containment" />
<Annotation Term="Core.LongDescription">
<String>The entities related via this navigation property have an existential dependency on their composition parent. The entity set of the composition parent MUST contain a NavigationPropertyBinding for this navigation property.</String>
</Annotation>
</Term>
<Term Name="SAPObjectNodeTypeReference" Type="Edm.String" Nullable="false" AppliesTo="Property">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="The name of the SAP Object Node Type referenced by the annotated property" />
</Term>
<Term Name="IsNaturalPerson" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="EntityType Annotation">
<Annotation Term="Core.Description" String="The annotated entity type (e.g. `Employee`) or annotation (e.g. `IsImageUrl`) represents a natural person" />
</Term>
<!-- Section: Value Help -->
<Term Name="ValueList" Type="Common.ValueListType" Nullable="false" AppliesTo="Property Parameter">
<Annotation Term="Core.Description" String="Specifies how to get a list of acceptable values for a property or parameter" />
<Annotation Term="Core.LongDescription" String="The value list can be based on user input that is passed in the value list request. The value list can be used for type-ahead and classical pick lists." />
</Term>
<ComplexType Name="ValueListType">
<!--
Example: Value list for currency code using entity set Currencies with properties Code, Text, Symbol and more
that are not needed in the value list
- CollectionPath: Currencies
- SearchSupported: true
- Parameters:
- - InOut: LocalDataProperty = CurrencyCode, ValueListPropert = Code
Example: Region within Country using entity set Regions with properties Code, Name, CountryCode
- CollectionPath: Regions
- SearchSupported: false
- Parameters:
- - InOut: LocalDataProperty = CountryCode, ValueListProperty = CountryCode
- - InOut: LocalDataProperty = RegionCode, ValueListProperty = Code
-->
<Annotation Term="Validation.ApplicableTerms">
<Collection>
<String>Common.QuickInfo</String>
</Collection>
</Annotation>
<Property Name="Label" Type="Edm.String" Nullable="true">
<Annotation Term="Core.IsLanguageDependent" />
<Annotation Term="Core.Description" String="Headline for value list, fallback is the label of the property or parameter" />
</Property>
<Property Name="CollectionPath" Type="Edm.String" Nullable="false">
<Annotation Term="Core.Description" String="Resource path of an OData collection with possible values, relative to CollectionRoot" />
</Property>
<Property Name="CollectionRoot" Type="Edm.String" Nullable="true">
<Annotation Term="Core.Description" String="Service root of the value list collection; not specified means local to the document containing the annotation" />
</Property>
<Property Name="DistinctValuesSupported" Type="Edm.Boolean" Nullable="false" DefaultValue="false">
<Annotation Term="Core.Description" String="Indicates that the value list supports a 'distinct' aggregation on the value list properties defined via ValueListParameterInOut and ValueListParameterOut" />
</Property>
<Property Name="SearchSupported" Type="Edm.Boolean" Nullable="false" DefaultValue="true">
<Annotation Term="Core.Description" String="Value list supports the $search query option" />
<Annotation Term="Core.LongDescription" String="The value of the target property is used as the search expression instead of in $filter" />
</Property>
<Property Name="FetchValues" Type="Common.FetchValuesType" Nullable="true">
<Annotation Term="Core.Description" String="Hint on when to fetch values" />
</Property>
<Property Name="PresentationVariantQualifier" Type="Core.SimpleIdentifier">
<Annotation Term="Core.Description" String="Alternative representation of a value help, e.g. as a bar chart" />
<Annotation Term="Core.LongDescription" String="Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the entity set identified via CollectionPath" />
</Property>
<Property Name="SelectionVariantQualifier" Type="Core.SimpleIdentifier">
<Annotation Term="Core.Description" String="Optional combination of parameters and filters to query the value help entity set" />
<Annotation Term="Core.LongDescription" String="Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath" />
</Property>
<Property Name="Parameters" Type="Collection(Common.ValueListParameter)" Nullable="false">
<Annotation Term="Core.Description" String="Instructions on how to construct the value list request and consume response properties" />
</Property>
</ComplexType>
<TypeDefinition Name="FetchValuesType" UnderlyingType="Edm.Byte">
<Annotation Term="Core.Description" String="Hint on when to fetch values" />
<Annotation Term="Validation.AllowedValues">
<Collection>
<Record>
<PropertyValue Property="Value" Int="1" />
<Annotation Term="Core.Description" String="Fetch values immediately without filter" />
</Record>
<Record>
<PropertyValue Property="Value" Int="2" />
<Annotation Term="Core.Description" String="Fetch values with a filter" />
</Record>
</Collection>
</Annotation>
</TypeDefinition>
<Term Name="ValueListRelevantQualifiers" Type="Collection(Core.SimpleIdentifier)" Nullable="false">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="List of qualifiers of relevant ValueList annotations" />
<Annotation Term="Core.LongDescription" String="The value of this annotation is a dynamic expression for calculating the qualifiers of relevant value lists depending on the values of one or more other properties." />
</Term>
<Term Name="ValueListWithFixedValues" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property Parameter">
<Annotation Term="Core.Description" String="If specified as true, there's only one value list mapping and its value list consists of a small number of fixed values" />
</Term>
<Term Name="ValueListForValidation" Type="Edm.String" Nullable="false" AppliesTo="Property Parameter">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="Contains the qualifier of the ValueList or ValueListMapping that should be used for validation" />
</Term>
<Term Name="ValueListReferences" Type="Collection(Edm.String)" Nullable="false" AppliesTo="Property Parameter">
<Annotation Term="Core.IsURL" />
<Annotation Term="Core.Description" String="A list of URLs of CSDL documents containing value list mappings for this parameter or property" />
</Term>
<Term Name="ValueListMapping" Type="Common.ValueListMappingType" Nullable="false" AppliesTo="Property Parameter">
<Annotation Term="Core.Description" String="Specifies the mapping between data service properties and value list properties" />
<Annotation Term="Core.LongDescription" String="The value list can be filtered based on user input. It can be used for type-ahead and classical pick lists. There may be many alternative mappings with different qualifiers." />
</Term>
<ComplexType Name="ValueListMappingType">
<Annotation Term="Validation.ApplicableTerms">
<Collection>
<String>Common.QuickInfo</String>
</Collection>
</Annotation>
<Property Name="Label" Type="Edm.String" Nullable="true">
<Annotation Term="Core.IsLanguageDependent" />
<Annotation Term="Core.Description" String="Headline for value list, fallback is the label of the property or parameter" />
</Property>
<Property Name="CollectionPath" Type="Edm.String" Nullable="false">
<Annotation Term="Core.Description" String="Resource path of an OData collection with possible values, relative to the document containing the value list mapping" />
</Property>
<Property Name="DistinctValuesSupported" Type="Edm.Boolean" Nullable="false" DefaultValue="false">
<Annotation Term="Core.Description" String="Indicates that the value list supports a 'distinct' aggregation on the value list properties defined via ValueListParameterInOut and ValueListParameterOut" />
</Property>
<Property Name="FetchValues" Type="Common.FetchValuesType" Nullable="true">
<Annotation Term="Core.Description" String="Hint on when to fetch values" />
</Property>
<Property Name="PresentationVariantQualifier" Type="Core.SimpleIdentifier">
<Annotation Term="Core.Description" String="Alternative representation of a value help, e.g. as a bar chart" />
<Annotation Term="Core.LongDescription" String="Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the value list entity set identified via CollectionPath in the ValueListReference annotation" />
</Property>
<Property Name="SelectionVariantQualifier" Type="Core.SimpleIdentifier">
<Annotation Term="Core.Description" String="Optional combination of parameters and filters to query the value help entity set" />
<Annotation Term="Core.LongDescription" String="Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath" />
</Property>
<Property Name="Parameters" Type="Collection(Common.ValueListParameter)" Nullable="false">
<Annotation Term="Core.Description" String="Instructions on how to construct the value list request and consume response properties" />
</Property>
</ComplexType>
<ComplexType Name="ValueListParameter" Abstract="true">
<Property Name="ValueListProperty" Type="Edm.String" Nullable="false">
<Annotation Term="Core.Description" String="Path to property in the value list . Format is identical to PropertyPath annotations." />
</Property>
</ComplexType>
<ComplexType Name="ValueListParameterIn" BaseType="Common.ValueListParameter">
<Property Name="LocalDataProperty" Type="Edm.PropertyPath" Nullable="false">
<Annotation Term="Core.Description" String="Path to property that is used to filter the value list with `eq` comparison" />
</Property>
<Property Name="InitialValueIsSignificant" Type="Edm.Boolean" DefaultValue="false" Nullable="false">
<Annotation Term="Core.Description" String="Initial value, e.g. empty string, is a valid and significant value" />
</Property>
</ComplexType>
<ComplexType Name="ValueListParameterConstant" BaseType="Common.ValueListParameter">
<Annotation Term="Common.Experimental" />
<Property Name="Constant" Type="Edm.PrimitiveType" Nullable="false">
<Annotation Term="Core.Description" String="Constant value that is used to filter the value list with `eq` comparison, using the same representation as property default values, see [CSDL XML, 7.2.7 Default Value](https://docs.oasis-open.org/odata/odata-csdl-xml/v4.01/odata-csdl-xml-v4.01.html#sec_DefaultValue)" />
</Property>
</ComplexType>
<ComplexType Name="ValueListParameterInOut" BaseType="Common.ValueListParameter">
<Property Name="LocalDataProperty" Type="Edm.PropertyPath" Nullable="false">
<Annotation Term="Core.Description" String="Path to property that is used to filter the value list with `startswith` comparison and filled from the picked value list item" />
</Property>
<Property Name="InitialValueIsSignificant" Type="Edm.Boolean" DefaultValue="false" Nullable="false">
<Annotation Term="Core.Description" String="Initial value, e.g. empty string, is a valid and significant value" />
</Property>
<Annotation Term="Validation.ApplicableTerms">
<Collection>
<String>UI.Importance</String>
</Collection>
</Annotation>
</ComplexType>
<ComplexType Name="ValueListParameterOut" BaseType="Common.ValueListParameter">
<Property Name="LocalDataProperty" Type="Edm.PropertyPath" Nullable="false">
<Annotation Term="Core.Description" String="Path to property that is filled from response" />
</Property>
<Annotation Term="Validation.ApplicableTerms">
<Collection>
<String>UI.Importance</String>
</Collection>
</Annotation>
</ComplexType>
<ComplexType Name="ValueListParameterDisplayOnly" BaseType="Common.ValueListParameter">
<Annotation Term="Core.Description" String="Value list property that is not used to fill the edited entity" />
<Annotation Term="Validation.ApplicableTerms">
<Collection>
<String>UI.Importance</String>
</Collection>
</Annotation>
</ComplexType>
<ComplexType Name="ValueListParameterFilterOnly" BaseType="Common.ValueListParameter">
<Annotation Term="Core.Description" String="Value list property that is used to filter the value list, not connected to the edited entity" />
<Annotation Term="Core.Revisions">
<Collection>
<Record>
<PropertyValue Property="Kind" EnumMember="Core.RevisionKind/Deprecated" />
<PropertyValue Property="Description" String="All filterable properties of the value list can be used to filter" />
</Record>
</Collection>
</Annotation>
</ComplexType>
<!-- Section: Calendar Points in Time -->
<Term Name="IsCalendarYear" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a year number as string following the logical pattern (-?)YYYY(Y*) consisting of an optional
minus sign for years B.C. followed by at least four digits. The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})
</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsCalendarHalfyear" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a halfyear number as string following the logical pattern H consisting of a single digit.
The string matches the regex pattern [1-2]
</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsCalendarQuarter" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a calendar quarter number as string following the logical pattern Q consisting of a single digit.
The string matches the regex pattern [1-4]
</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsCalendarMonth" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a calendar month number as string following the logical pattern MM consisting of two digits.
The string matches the regex pattern 0[1-9]|1[0-2]
</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsCalendarWeek" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a calendar week number as string following the logical pattern WW consisting of two digits.
The string matches the regex pattern 0[1-9]|[1-4][0-9]|5[0-3]
</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsDayOfCalendarMonth" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Day number relative to a calendar month. Valid values are between 1 and 31.
</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.SByte" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsDayOfCalendarYear" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Day number relative to a calendar year. Valid values are between 1 and 366.
</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.Int16" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsCalendarYearHalfyear" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a calendar year and halfyear as string following the logical pattern (-?)YYYY(Y*)H consisting
of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the halfyear.
The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})[1-2]
</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsCalendarYearQuarter" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a calendar year and quarter as string following the logical pattern (-?)YYYY(Y*)Q consisting
of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the quarter.
The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})[1-4]
</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsCalendarYearMonth" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a calendar year and month as string following the logical pattern (-?)YYYY(Y*)MM consisting
of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent the months January to
December.
The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})(0[1-9]|1[0-2])
</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsCalendarYearWeek" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a calendar year and week as string following the logical pattern (-?)YYYY(Y*)WW consisting
of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent week number in the year.
The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})(0[1-9]|[1-4][0-9]|5[0-3])
</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsCalendarDate" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a calendar date: year, month and day as string following the logical pattern (-?)YYYY(Y*)MMDD consisting
of an optional minus sign for years B.C. followed by at least eight digits, where the last four digits represent
the months January to December (MM) and the day of the month (DD).
The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})(0[1-9]|1[0-2])(0[1-9]|[12][0-9]|3[01])
The regex pattern does not reflect the additional constraint for "Day-of-month Values":
The day value must be no more than 30 if month is one of 04, 06, 09, or 11, no more than 28 if month is 02 and year is not divisible by 4,
or is divisible by 100 but not by 400, and no more than 29 if month is 02 and year is divisible by 400, or by 4 but not by 100.
</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<!-- Section: Fiscal Points in Time -->
<Term Name="IsFiscalYear" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a fiscal year number as string following the logical pattern YYYY consisting of four digits.
The string matches the regex pattern [1-9][0-9]{3}
</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsFiscalPeriod" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a fiscal period as string following the logical pattern PPP consisting of three digits.
The string matches the regex pattern [0-9]{3}
</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsFiscalYearPeriod" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a fiscal year and period as string following the logical pattern YYYYPPP consisting
of seven digits, where the last three digits represent the fiscal period in the year.
The string matches the regex pattern ([1-9][0-9]{3})([0-9]{3})
</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsFiscalQuarter" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a fiscal quarter number as string following the logical pattern Q consisting of a single digit.
The string matches the regex pattern [1-4]</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsFiscalYearQuarter" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a fiscal year and quarter as string following the logical pattern YYYYQ consisting of
five digits, where the last digit represents the quarter.
The string matches the regex pattern [1-9][0-9]{3}[1-4]</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsFiscalWeek" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a fiscal week number as string following the logical pattern WW consisting of two digits.
The string matches the regex pattern 0[1-9]|[1-4][0-9]|5[0-3]</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsFiscalYearWeek" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Property encodes a fiscal year and week as string following the logical pattern YYYYWW consisting of
six digits, where the last two digits represent the week number in the year.
The string matches the regex pattern [1-9][0-9]{3}(0[1-9]|[1-4][0-9]|5[0-3])</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsDayOfFiscalYear" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description">
<String>Day number relative to a fiscal year. Valid values are between 1 and 371.</String>
</Annotation>
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<Term Name="IsFiscalYearVariant" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Property">
<Annotation Term="Core.Description" String="Property encodes a fiscal year variant" />
<Annotation Term="Core.RequiresType" String="Edm.String" />
<Annotation Term="Common.MutuallyExclusiveTerm" Qualifier="DatePart" />
</Term>
<!-- Section: Term Constraints -->
<Term Name="MutuallyExclusiveTerm" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Term">
<Annotation Term="Core.Description" String="Only one term of the group identified with the Qualifier attribute can be applied" />
</Term>
<!-- Section: Draft Handling -->
<Term Name="DraftRoot" Type="Common.DraftRootType" Nullable="false" AppliesTo="EntitySet">
<Annotation Term="Core.Description">
<String>Root entities of business documents that support the draft pattern</String>
</Annotation>
</Term>
<ComplexType Name="DraftRootType" BaseType="Common.DraftNodeType">
<Property Name="ActivationAction" Type="Common.QualifiedName" Nullable="false">
<Annotation Term="Core.Description" String="Action that activates a draft document" />
</Property>
<Property Name="DiscardAction" Type="Common.QualifiedName" Nullable="true">