Optional user interaction

SAP · HeikoTheissen · Oct 7, 2020 · Oct 7, 2020 · Oct 7, 2020 · Oct 8, 2020
commit 2925e365fb6783ad6a61e92884989f339bf997ae
diff --git a/vocabularies/UI.json b/vocabularies/UI.json
@@ -1828,7 +1828,7 @@
       "$Kind": "Term",
       "$Type": "UI.UserInteractionType",
       "$AppliesTo": ["NavigationProperty"],
-      "@Core.Description": "When the annotated navigation property or its `odata.navigationLink` occurs in a response,\n          the UI shall use the addressed entity or collection to interact with the user\n          and optionally repeat the corresponding request with the additional information obtained from the user",
+      "@Core.Description": "When the annotated navigation property or its `odata.navigationLink` occurs in a response,\n          the UI shall use the addressed entity or collection to interact with the user\n          and then repeat the corresponding request with the additional information obtained from the user",
       "@Core.LongDescription": "If the response is an [error response](https://docs.oasis-open.org/odata/odata-json-format/v4.01/odata-json-format-v4.01.html#sec_ErrorResponse),\n          the annotated navigation property MAY occur in a [`Common.callback`](Common.md#callback) instance annotation.\n          A navigation property thus annotated may be interpreted as not belonging to the object model\n          but containing auxiliary information that is not always needed. See also [this example](../examples/UI.UserInteraction-sample.md)."
     },
     "UserInteractionSimple": {
@@ -1869,27 +1869,20 @@
         "@Core.LongDescription": "This property is handled like [`Common.ValueListType/Parameters`](Common.md#ValueListType), as if the target of the annotated navigation property was a value list,\n            but one that was sent by the server rather than requested by the user.\n            If `UI.UserInteraction/Parameters/LocalDataProperty` points to a parameter of an action that was not invoked by the request,\n            the UI shall invoke that action instead of repeating the request."
       }
     },
-    "UserInteractionMandatory": {
-      "$Kind": "ComplexType",
-      "$Abstract": true,
-      "$BaseType": "UI.UserInteractionType",
-      "@Core.Description": "The user interaction is mandatory for the corresponding request to be executed",
-      "@Core.LongDescription": "After the user action, the request is repeated with the additional information obtained from the user.\n          If the user action is aborted, the request has had no effect."
-    },
     "UserInteractionChooseSingle": {
       "$Kind": "ComplexType",
-      "$BaseType": "UI.UserInteractionMandatory",
+      "$BaseType": "UI.UserInteractionType",
       "@Core.Description": "The user shall choose a single entry from the collection and its properties shall be inserted into the repeated request"
     },
     "UserInteractionChooseMultiple": {
       "$Kind": "ComplexType",
-      "$BaseType": "UI.UserInteractionMandatory",
+      "$BaseType": "UI.UserInteractionType",
       "@Core.Description": "The user shall choose zero or more entries from the collection and a collection of their properties shall be inserted into the repeated request",
       "@Core.LongDescription": "The properties referenced by `UI.UserInteraction/Parameters/LocalDataProperty` belong to a collection\n          that contains one instance per chosen entry."
     },
     "UserInteractionResolveConflict": {
       "$Kind": "ComplexType",
-      "$BaseType": "UI.UserInteractionMandatory",
+      "$BaseType": "UI.UserInteractionChooseMultiple",
       "@Core.Description": "The user shall resolve a conflict between the entries in the collection and the entire collection shall be inserted into the repeated request"
     },
     "UserInteractionConfirm": {

diff --git a/vocabularies/UI.md b/vocabularies/UI.md
@@ -79,9 +79,9 @@ Term|Type|Description
 [Recommendations](UI.xml#L1949) *([Experimental](Common.md#Experimental))*|ComplexType|<a name="Recommendations"></a>Recommendations for an entity<br>This complex-typed annotation contains structural properties corresponding via name equality to non-key structural primitive properties of the entity type for which recommendations are available. The type of such a property is a collection of a informal specialization of [`PropertyRecommendationType`](#PropertyRecommendationType). (The specializiations are called "informal" because they may omit the property `RecommendedFieldDescription`.)<br>Clients retrieve the recommendations with a GET request that includes this annotation in a `$select` clause. The recommendations MAY be computed asynchronously, see [this diagram](../docs/recommendations.md).
 [ExcludeFromNavigationContext](UI.xml#L1995)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|<a name="ExcludeFromNavigationContext"></a>The contents of this property must not be propagated to the app-to-app navigation context
 [DoNotCheckScaleOfMeasuredQuantity](UI.xml#L1999) *([Experimental](Common.md#Experimental))*|Boolean|<a name="DoNotCheckScaleOfMeasuredQuantity"></a>Do not check the number of fractional digits of the annotated measured quantity<br>The annotated property contains a measured quantity, and the user may enter more fractional digits than defined for the corresponding unit of measure.<br>This switches off the validation of user input with respect to decimals.
-[UserInteraction](UI.xml#L2009)|[UserInteractionType](#UserInteractionType)|<a name="UserInteraction"></a>When the annotated navigation property or its `odata.navigationLink` occurs in a response, the UI shall use the addressed entity or collection to interact with the user and optionally repeat the corresponding request with the additional information obtained from the user<br>If the response is an [error response](https://docs.oasis-open.org/odata/odata-json-format/v4.01/odata-json-format-v4.01.html#sec_ErrorResponse), the annotated navigation property MAY occur in a [`Common.callback`](Common.md#callback) instance annotation. A navigation property thus annotated may be interpreted as not belonging to the object model but containing auxiliary information that is not always needed. See also [this example](../examples/UI.UserInteraction-sample.md).
+[UserInteraction](UI.xml#L2009)|[UserInteractionType](#UserInteractionType)|<a name="UserInteraction"></a>When the annotated navigation property or its `odata.navigationLink` occurs in a response, the UI shall use the addressed entity or collection to interact with the user and then repeat the corresponding request with the additional information obtained from the user<br>If the response is an [error response](https://docs.oasis-open.org/odata/odata-json-format/v4.01/odata-json-format-v4.01.html#sec_ErrorResponse), the annotated navigation property MAY occur in a [`Common.callback`](Common.md#callback) instance annotation. A navigation property thus annotated may be interpreted as not belonging to the object model but containing auxiliary information that is not always needed. See also [this example](../examples/UI.UserInteraction-sample.md).
 [UserInteractionSimple](UI.xml#L2022)|\[Untyped\]<br>Allowed Derived Types:<ul><li>Binary</li><li>Boolean</li><li>Byte</li><li>Date</li><li>DateTimeOffset</li><li>Decimal</li><li>Double</li><li>Duration</li><li>Guid</li><li>Int16</li><li>Int32</li><li>Int64</li><li>SByte</li><li>Single</li><li>String</li><li>TimeOfDay</li></ul>|<a name="UserInteractionSimple"></a>When this instance annotation occurs in a response, the UI shall let the user choose from the collection and then repeat the corresponding request with the annotated property set to the chosen value<br>If the response is an [error response](https://docs.oasis-open.org/odata/odata-json-format/v4.01/odata-json-format-v4.01.html#sec_ErrorResponse), the instance annotation MAY occur in a [`Common.callback`](Common.md#callback) instance annotation.
-[LeadingEntitySet](UI.xml#L2089) *([Experimental](Common.md#Experimental))*|String|<a name="LeadingEntitySet"></a>The referenced entity set is the preferred starting point for UIs using this service
+[LeadingEntitySet](UI.xml#L2082) *([Experimental](Common.md#Experimental))*|String|<a name="LeadingEntitySet"></a>The referenced entity set is the preferred starting point for UIs using this service
 
 <a name="HeaderInfoType"></a>
 ## [HeaderInfoType](UI.xml#L68)
@@ -1194,69 +1194,55 @@ Property|Type|Description
 Derived types can add more properties that govern the user interaction and the repeating of the request
 
 **Derived Types:**
-- *[UserInteractionMandatory](#UserInteractionMandatory)*
-  - [UserInteractionChooseSingle](#UserInteractionChooseSingle)
-  - [UserInteractionChooseMultiple](#UserInteractionChooseMultiple)
+- [UserInteractionChooseSingle](#UserInteractionChooseSingle)
+- [UserInteractionChooseMultiple](#UserInteractionChooseMultiple)
   - [UserInteractionResolveConflict](#UserInteractionResolveConflict)
 - [UserInteractionConfirm](#UserInteractionConfirm)
 
 Property|Type|Description
 :-------|:---|:----------
 [Parameters](UI.xml#L2055)|\[[ValueListParameterOut](Common.md#ValueListParameterOut)\]|Instructions how to fill properties with the additional information obtained from the user<br>This property is handled like [`Common.ValueListType/Parameters`](Common.md#ValueListType), as if the target of the annotated navigation property was a value list, but one that was sent by the server rather than requested by the user. If `UI.UserInteraction/Parameters/LocalDataProperty` points to a parameter of an action that was not invoked by the request, the UI shall invoke that action instead of repeating the request.
 
-<a name="UserInteractionMandatory"></a>
-## [*UserInteractionMandatory*](UI.xml#L2065): [UserInteractionType](#UserInteractionType)
-The user interaction is mandatory for the corresponding request to be executed
-
-After the user action, the request is repeated with the additional information obtained from the user.
-          If the user action is aborted, the request has had no effect.
-
-**Derived Types:**
-- [UserInteractionChooseSingle](#UserInteractionChooseSingle)
-- [UserInteractionChooseMultiple](#UserInteractionChooseMultiple)
-- [UserInteractionResolveConflict](#UserInteractionResolveConflict)
-
-Property|Type|Description
-:-------|:---|:----------
-[*Parameters*](UI.xml#L2055)|\[[ValueListParameterOut](Common.md#ValueListParameterOut)\]|Instructions how to fill properties with the additional information obtained from the user<br>This property is handled like [`Common.ValueListType/Parameters`](Common.md#ValueListType), as if the target of the annotated navigation property was a value list, but one that was sent by the server rather than requested by the user. If `UI.UserInteraction/Parameters/LocalDataProperty` points to a parameter of an action that was not invoked by the request, the UI shall invoke that action instead of repeating the request.
-
 <a name="UserInteractionChooseSingle"></a>
-## [UserInteractionChooseSingle](UI.xml#L2072): [UserInteractionMandatory](#UserInteractionMandatory)
+## [UserInteractionChooseSingle](UI.xml#L2065): [UserInteractionType](#UserInteractionType)
 The user shall choose a single entry from the collection and its properties shall be inserted into the repeated request
 
 Property|Type|Description
 :-------|:---|:----------
 [*Parameters*](UI.xml#L2055)|\[[ValueListParameterOut](Common.md#ValueListParameterOut)\]|Instructions how to fill properties with the additional information obtained from the user<br>This property is handled like [`Common.ValueListType/Parameters`](Common.md#ValueListType), as if the target of the annotated navigation property was a value list, but one that was sent by the server rather than requested by the user. If `UI.UserInteraction/Parameters/LocalDataProperty` points to a parameter of an action that was not invoked by the request, the UI shall invoke that action instead of repeating the request.
 
 <a name="UserInteractionChooseMultiple"></a>
-## [UserInteractionChooseMultiple](UI.xml#L2075): [UserInteractionMandatory](#UserInteractionMandatory)
+## [UserInteractionChooseMultiple](UI.xml#L2068): [UserInteractionType](#UserInteractionType)
 The user shall choose zero or more entries from the collection and a collection of their properties shall be inserted into the repeated request
 
 The properties referenced by `UI.UserInteraction/Parameters/LocalDataProperty` belong to a collection
           that contains one instance per chosen entry.
 
+**Derived Types:**
+- [UserInteractionResolveConflict](#UserInteractionResolveConflict)
+
 Property|Type|Description
 :-------|:---|:----------
 [*Parameters*](UI.xml#L2055)|\[[ValueListParameterOut](Common.md#ValueListParameterOut)\]|Instructions how to fill properties with the additional information obtained from the user<br>This property is handled like [`Common.ValueListType/Parameters`](Common.md#ValueListType), as if the target of the annotated navigation property was a value list, but one that was sent by the server rather than requested by the user. If `UI.UserInteraction/Parameters/LocalDataProperty` points to a parameter of an action that was not invoked by the request, the UI shall invoke that action instead of repeating the request.
 
 <a name="UserInteractionResolveConflict"></a>
-## [UserInteractionResolveConflict](UI.xml#L2082): [UserInteractionMandatory](#UserInteractionMandatory)
+## [UserInteractionResolveConflict](UI.xml#L2075): [UserInteractionChooseMultiple](#UserInteractionChooseMultiple)
 The user shall resolve a conflict between the entries in the collection and the entire collection shall be inserted into the repeated request
 
 Property|Type|Description
 :-------|:---|:----------
 [*Parameters*](UI.xml#L2055)|\[[ValueListParameterOut](Common.md#ValueListParameterOut)\]|Instructions how to fill properties with the additional information obtained from the user<br>This property is handled like [`Common.ValueListType/Parameters`](Common.md#ValueListType), as if the target of the annotated navigation property was a value list, but one that was sent by the server rather than requested by the user. If `UI.UserInteraction/Parameters/LocalDataProperty` points to a parameter of an action that was not invoked by the request, the UI shall invoke that action instead of repeating the request.
 
 <a name="UserInteractionConfirm"></a>
-## [UserInteractionConfirm](UI.xml#L2085): [UserInteractionType](#UserInteractionType)
+## [UserInteractionConfirm](UI.xml#L2078): [UserInteractionType](#UserInteractionType)
 The entity or collection is a preview of the effects of the request and the user shall confirm whether to repeat the request in "effective" mode
 
 Property|Type|Description
 :-------|:---|:----------
 [*Parameters*](UI.xml#L2055)|\[[ValueListParameterOut](Common.md#ValueListParameterOut)\]|Instructions how to fill properties with the additional information obtained from the user<br>This property is handled like [`Common.ValueListType/Parameters`](Common.md#ValueListType), as if the target of the annotated navigation property was a value list, but one that was sent by the server rather than requested by the user. If `UI.UserInteraction/Parameters/LocalDataProperty` points to a parameter of an action that was not invoked by the request, the UI shall invoke that action instead of repeating the request.
 
 <a name="ActionName"></a>
-## [ActionName](UI.xml#L2094)
+## [ActionName](UI.xml#L2087)
 **Type:** String
 
 Name of an Action, Function, ActionImport, or FunctionImport in scope

diff --git a/vocabularies/UI.xml b/vocabularies/UI.xml
@@ -2010,7 +2010,7 @@ This switches off the validation of user input with respect to decimals.</String
         <Annotation Term="Core.Description">
           <String>When the annotated navigation property or its `odata.navigationLink` occurs in a response,
           the UI shall use the addressed entity or collection to interact with the user
-          and optionally repeat the corresponding request with the additional information obtained from the user</String>
+          and then repeat the corresponding request with the additional information obtained from the user</String>
         </Annotation>
         <Annotation Term="Core.LongDescription">
           <String>If the response is an [error response](https://docs.oasis-open.org/odata/odata-json-format/v4.01/odata-json-format-v4.01.html#sec_ErrorResponse),
@@ -2062,24 +2062,17 @@ This switches off the validation of user input with respect to decimals.</String
           </Annotation>
         </Property>
       </ComplexType>
-      <ComplexType Name="UserInteractionMandatory" BaseType="UI.UserInteractionType" Abstract="true">
-        <Annotation Term="Core.Description" String="The user interaction is mandatory for the corresponding request to be executed" />
-        <Annotation Term="Core.LongDescription">
-          <String>After the user action, the request is repeated with the additional information obtained from the user.
-          If the user action is aborted, the request has had no effect.</String>
-        </Annotation>
-      </ComplexType>
-      <ComplexType Name="UserInteractionChooseSingle" BaseType="UI.UserInteractionMandatory">
+      <ComplexType Name="UserInteractionChooseSingle" BaseType="UI.UserInteractionType">
         <Annotation Term="Core.Description" String="The user shall choose a single entry from the collection and its properties shall be inserted into the repeated request"/>
       </ComplexType>
-      <ComplexType Name="UserInteractionChooseMultiple" BaseType="UI.UserInteractionMandatory">
+      <ComplexType Name="UserInteractionChooseMultiple" BaseType="UI.UserInteractionType">
         <Annotation Term="Core.Description" String="The user shall choose zero or more entries from the collection and a collection of their properties shall be inserted into the repeated request"/>
         <Annotation Term="Core.LongDescription">
           <String>The properties referenced by `UI.UserInteraction/Parameters/LocalDataProperty` belong to a collection
           that contains one instance per chosen entry.</String>
         </Annotation>
       </ComplexType>
-      <ComplexType Name="UserInteractionResolveConflict" BaseType="UI.UserInteractionMandatory">
+      <ComplexType Name="UserInteractionResolveConflict" BaseType="UI.UserInteractionChooseMultiple">
         <Annotation Term="Core.Description" String="The user shall resolve a conflict between the entries in the collection and the entire collection shall be inserted into the repeated request"/>
       </ComplexType>
       <ComplexType Name="UserInteractionConfirm" BaseType="UI.UserInteractionType">