chore: Update JavaDocs for release 5.11.0 (#1879)

SAP · Aug 1, 2024 · d95ff02 · d95ff02
1 parent 9367d83
commit d95ff02
Show file tree

Hide file tree

Showing 1,647 changed files with 6,965 additions and 6,797 deletions.
diff --git a/static/java-api/v5/allclasses-index.html b/static/java-api/v5/allclasses-index.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
-<html lang="en">
+<html lang>
 <head>
-<!-- Generated by javadoc (17) on Wed Jun 12 14:38:18 UTC 2024 -->
-<title>All Classes and Interfaces (SAP Cloud SDK - Parent POM 5.10.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Aug 01 12:11:09 UTC 2024 -->
+<title>All Classes and Interfaces (SAP Cloud SDK - Parent POM 5.11.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-06-12">
+<meta name="dc.created" content="2024-08-01">
 <meta name="description" content="class index">
 <meta name="generator" content="javadoc/AllClassesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -1091,7 +1091,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 </div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/sap/cloud/sdk/datamodel/odata/helper/EntityFieldAll.html" title="class in com.sap.cloud.sdk.datamodel.odata.helper">EntityFieldAll</a>&lt;<a href="com/sap/cloud/sdk/datamodel/odata/helper/EntityFieldAll.html" title="type parameter in EntityFieldAll">EntityT</a> extends <a href="com/sap/cloud/sdk/datamodel/odata/helper/VdmObject.html" title="class in com.sap.cloud.sdk.datamodel.odata.helper">VdmObject</a>&lt;?&gt;&gt;</div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
-<div class="block">OData selector for entities to select each and every field, i.e.</div>
+<div class="block">OData selector for entities to select each and every field, i.e. star selector.</div>
 </div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/sap/cloud/sdk/datamodel/odata/helper/EntityLink.html" title="class in com.sap.cloud.sdk.datamodel.odata.helper">EntityLink</a>&lt;<a href="com/sap/cloud/sdk/datamodel/odata/helper/EntityLink.html" title="type parameter in EntityLink">LinkT</a> extends <a href="com/sap/cloud/sdk/datamodel/odata/helper/EntityLink.html" title="class in com.sap.cloud.sdk.datamodel.odata.helper">EntityLink</a>&lt;<a href="com/sap/cloud/sdk/datamodel/odata/helper/EntityLink.html" title="type parameter in EntityLink">LinkT</a>,<wbr><a href="com/sap/cloud/sdk/datamodel/odata/helper/EntityLink.html" title="type parameter in EntityLink">EntityT</a>,<wbr><a href="com/sap/cloud/sdk/datamodel/odata/helper/EntityLink.html" title="type parameter in EntityLink">SubEntityT</a>&gt;,<wbr><a href="com/sap/cloud/sdk/datamodel/odata/helper/EntityLink.html" title="type parameter in EntityLink">EntityT</a> extends <a href="com/sap/cloud/sdk/datamodel/odata/helper/VdmObject.html" title="class in com.sap.cloud.sdk.datamodel.odata.helper">VdmObject</a>&lt;?&gt;,<wbr><a href="com/sap/cloud/sdk/datamodel/odata/helper/EntityLink.html" title="type parameter in EntityLink">SubEntityT</a> extends <a href="com/sap/cloud/sdk/datamodel/odata/helper/VdmObject.html" title="class in com.sap.cloud.sdk.datamodel.odata.helper">VdmObject</a>&lt;?&gt;&gt;</div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
@@ -1812,7 +1812,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 </div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="com/sap/cloud/sdk/s4hana/connectivity/rfc/exception/MissingErpConfigException.html" title="class in com.sap.cloud.sdk.s4hana.connectivity.rfc.exception">MissingErpConfigException</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab5">
-<div class="block">Thrown when an ERP configuration prevents an action (e.g.</div>
+<div class="block">Thrown when an ERP configuration prevents an action (e.g. workflow not enabled).</div>
 </div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/sap/cloud/sdk/s4hana/connectivity/rfc/exception/MissingErpConfigurationExceptionFactory.html" title="class in com.sap.cloud.sdk.s4hana.connectivity.rfc.exception">MissingErpConfigurationExceptionFactory</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
@@ -2025,7 +2025,12 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
  <strong><a href="com/sap/cloud/sdk/datamodel/odata/client/exception/ODataRequestException.html" title="class in com.sap.cloud.sdk.datamodel.odata.client.exception"><code>ODataRequestException</code></a></strong><br>
  When the OData request could not be sent due to a generic reason.
  <strong><a href="com/sap/cloud/sdk/datamodel/odata/client/exception/ODataResponseException.html" title="class in com.sap.cloud.sdk.datamodel.odata.client.exception"><code>ODataResponseException</code></a></strong><br>
- If the response code infers an unhealthy state, i.e.</div>
+ If the response code infers an unhealthy state, i.e. when >= 400
+ <strong><a href="com/sap/cloud/sdk/datamodel/odata/client/exception/ODataDeserializationException.html" title="class in com.sap.cloud.sdk.datamodel.odata.client.exception"><code>ODataDeserializationException</code></a></strong><br>
+ When deserialization process failed for the OData response object.
+ <strong><a href="com/sap/cloud/sdk/datamodel/odata/client/exception/ODataServiceErrorException.html" title="class in com.sap.cloud.sdk.datamodel.odata.client.exception"><code>ODataServiceErrorException</code></a></strong><br>
+ If the response contains an OData error in the payload.
+ </div>
 </div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab7"><a href="com/sap/cloud/sdk/s4hana/datamodel/odata/adapter/ODataField.html" title="annotation interface in com.sap.cloud.sdk.s4hana.datamodel.odata.adapter">ODataField</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab7">
@@ -2502,11 +2507,13 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="com/sap/cloud/sdk/result/ResultCollection.html" title="interface in com.sap.cloud.sdk.result">ResultCollection</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab1">
-<div class="block">Interface representing one collection of result elements (e.g.</div>
+<div class="block">Interface representing one collection of result elements (e.g. a list of complex business objects) resulting from a
+ call to an external service (e.g. after invoking a BAPI or a remote-enabled function module).</div>
 </div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/sap/cloud/sdk/result/ResultElement.html" title="interface in com.sap.cloud.sdk.result">ResultElement</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
-<div class="block">Class representing one resulting element from a call to an external service (e.g.</div>
+<div class="block">Class representing one resulting element from a call to an external service (e.g. after invoking a BAPI or a
+ remote-enabled function module).</div>
 </div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="com/sap/cloud/sdk/result/ResultElementFactory.html" title="interface in com.sap.cloud.sdk.result">ResultElementFactory</a>&lt;<a href="com/sap/cloud/sdk/result/ResultElementFactory.html" title="type parameter in ResultElementFactory">ResultElementT</a>&gt;</div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab1">
@@ -2515,11 +2522,12 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/sap/cloud/sdk/result/ResultObject.html" title="interface in com.sap.cloud.sdk.result">ResultObject</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
 <div class="block">Interface representing one structured object (e.g one complex business object) resulting from a call to an external
- service (e.g.</div>
+ service (e.g. after invoking a BAPI or a remote-enabled function module).</div>
 </div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="com/sap/cloud/sdk/result/ResultPrimitive.html" title="interface in com.sap.cloud.sdk.result">ResultPrimitive</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab1">
-<div class="block">Class representing an unstructured result primitive resulting from a call to an external service (e.g.</div>
+<div class="block">Class representing an unstructured result primitive resulting from a call to an external service (e.g. after invoking
+ a BAPI or a remote-enabled function module).</div>
 </div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/sap/cloud/sdk/cloudplatform/resilience4j/RetryProvider.html" title="interface in com.sap.cloud.sdk.cloudplatform.resilience4j">RetryProvider</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab1">

diff --git a/static/java-api/v5/allpackages-index.html b/static/java-api/v5/allpackages-index.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
-<html lang="en">
+<html lang>
 <head>
-<!-- Generated by javadoc (17) on Wed Jun 12 14:38:18 UTC 2024 -->
-<title>All Packages (SAP Cloud SDK - Parent POM 5.10.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Aug 01 12:11:09 UTC 2024 -->
+<title>All Packages (SAP Cloud SDK - Parent POM 5.11.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-06-12">
+<meta name="dc.created" content="2024-08-01">
 <meta name="description" content="package index">
 <meta name="generator" content="javadoc/AllPackagesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/DwcHeaderUtils.html b/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/DwcHeaderUtils.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
-<html lang="en">
+<html lang>
 <head>
-<!-- Generated by javadoc (17) on Wed Jun 12 14:38:18 UTC 2024 -->
-<title>DwcHeaderUtils (SAP Cloud SDK - Parent POM 5.10.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Aug 01 12:11:09 UTC 2024 -->
+<title>DwcHeaderUtils (SAP Cloud SDK - Parent POM 5.11.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-06-12">
+<meta name="dc.created" content="2024-08-01">
 <meta name="description" content="declaration: package: com.sap.cloud.sdk.cloudplatform, class: DwcHeaderUtils">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

diff --git a/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/PlatformSslContextProvider.html b/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/PlatformSslContextProvider.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
-<html lang="en">
+<html lang>
 <head>
-<!-- Generated by javadoc (17) on Wed Jun 12 14:38:18 UTC 2024 -->
-<title>PlatformSslContextProvider (SAP Cloud SDK - Parent POM 5.10.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Aug 01 12:11:09 UTC 2024 -->
+<title>PlatformSslContextProvider (SAP Cloud SDK - Parent POM 5.11.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-06-12">
+<meta name="dc.created" content="2024-08-01">
 <meta name="description" content="declaration: package: com.sap.cloud.sdk.cloudplatform, interface: PlatformSslContextProvider">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

diff --git a/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/cache/CacheKey.html b/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/cache/CacheKey.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
-<html lang="en">
+<html lang>
 <head>
-<!-- Generated by javadoc (17) on Wed Jun 12 14:38:18 UTC 2024 -->
-<title>CacheKey (SAP Cloud SDK - Parent POM 5.10.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Aug 01 12:11:09 UTC 2024 -->
+<title>CacheKey (SAP Cloud SDK - Parent POM 5.11.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-06-12">
+<meta name="dc.created" content="2024-08-01">
 <meta name="description" content="declaration: package: com.sap.cloud.sdk.cloudplatform.cache, class: CacheKey">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">

diff --git a/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/cache/CacheManager.html b/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/cache/CacheManager.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
-<html lang="en">
+<html lang>
 <head>
-<!-- Generated by javadoc (17) on Wed Jun 12 14:38:18 UTC 2024 -->
-<title>CacheManager (SAP Cloud SDK - Parent POM 5.10.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Aug 01 12:11:09 UTC 2024 -->
+<title>CacheManager (SAP Cloud SDK - Parent POM 5.11.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-06-12">
+<meta name="dc.created" content="2024-08-01">
 <meta name="description" content="declaration: package: com.sap.cloud.sdk.cloudplatform.cache, class: CacheManager">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">

diff --git a/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/cache/CacheRuntimeException.html b/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/cache/CacheRuntimeException.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
-<html lang="en">
+<html lang>
 <head>
-<!-- Generated by javadoc (17) on Wed Jun 12 14:38:18 UTC 2024 -->
-<title>CacheRuntimeException (SAP Cloud SDK - Parent POM 5.10.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Aug 01 12:11:09 UTC 2024 -->
+<title>CacheRuntimeException (SAP Cloud SDK - Parent POM 5.11.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-06-12">
+<meta name="dc.created" content="2024-08-01">
 <meta name="description" content="declaration: package: com.sap.cloud.sdk.cloudplatform.cache, class: CacheRuntimeException">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">

diff --git a/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/cache/CacheStats.html b/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/cache/CacheStats.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
-<html lang="en">
+<html lang>
 <head>
-<!-- Generated by javadoc (17) on Wed Jun 12 14:38:18 UTC 2024 -->
-<title>CacheStats (SAP Cloud SDK - Parent POM 5.10.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Aug 01 12:11:09 UTC 2024 -->
+<title>CacheStats (SAP Cloud SDK - Parent POM 5.11.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-06-12">
+<meta name="dc.created" content="2024-08-01">
 <meta name="description" content="declaration: package: com.sap.cloud.sdk.cloudplatform.cache, class: CacheStats">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">

diff --git a/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/cache/CacheStatsMXBean.html b/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/cache/CacheStatsMXBean.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
-<html lang="en">
+<html lang>
 <head>
-<!-- Generated by javadoc (17) on Wed Jun 12 14:38:18 UTC 2024 -->
-<title>CacheStatsMXBean (SAP Cloud SDK - Parent POM 5.10.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Aug 01 12:11:09 UTC 2024 -->
+<title>CacheStatsMXBean (SAP Cloud SDK - Parent POM 5.11.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-06-12">
+<meta name="dc.created" content="2024-08-01">
 <meta name="description" content="declaration: package: com.sap.cloud.sdk.cloudplatform.cache, interface: CacheStatsMXBean">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">

diff --git a/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/cache/CacheUtil.html b/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/cache/CacheUtil.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
-<html lang="en">
+<html lang>
 <head>
-<!-- Generated by javadoc (17) on Wed Jun 12 14:38:18 UTC 2024 -->
-<title>CacheUtil (SAP Cloud SDK - Parent POM 5.10.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Aug 01 12:11:09 UTC 2024 -->
+<title>CacheUtil (SAP Cloud SDK - Parent POM 5.11.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-06-12">
+<meta name="dc.created" content="2024-08-01">
 <meta name="description" content="declaration: package: com.sap.cloud.sdk.cloudplatform.cache, class: CacheUtil">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">

diff --git a/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/cache/GenericCacheKey.html b/static/java-api/v5/com/sap/cloud/sdk/cloudplatform/cache/GenericCacheKey.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
-<html lang="en">
+<html lang>
 <head>
-<!-- Generated by javadoc (17) on Wed Jun 12 14:38:18 UTC 2024 -->
-<title>GenericCacheKey (SAP Cloud SDK - Parent POM 5.10.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Aug 01 12:11:09 UTC 2024 -->
+<title>GenericCacheKey (SAP Cloud SDK - Parent POM 5.11.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2024-06-12">
+<meta name="dc.created" content="2024-08-01">
 <meta name="description" content="declaration: package: com.sap.cloud.sdk.cloudplatform.cache, interface: GenericCacheKey">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">