FluentHelperT
- The fluent helper type.EntityT
- The type of the entity to delete.public abstract class FluentHelperDelete<FluentHelperT,EntityT extends VdmEntity<?>> extends FluentHelperBasic<FluentHelperT,EntityT,com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteResult>
executing
it.Constructor and Description |
---|
FluentHelperDelete(String servicePath)
Instantiates this fluent helper using the given service path to send the requests.
|
FluentHelperDelete(String servicePath,
String entityCollection)
Instantiates this fluent helper using the given service path and entity collection to send the requests.
|
Modifier and Type | Method and Description |
---|---|
FluentHelperT |
disableVersionIdentifier()
The delete request will ignore any version identifier present on the entity and not send an `If-Match` header.
|
com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteResult |
execute(HttpDestinationProperties destination)
Deprecated.
Use the improved method
executeRequest(HttpDestinationProperties) instead. |
ModificationResponse<EntityT> |
executeRequest(HttpDestinationProperties destination)
Executes this request.
|
protected abstract EntityT |
getEntity()
The entity object to be deleted by calling the
executeRequest(HttpDestinationProperties) method. |
protected Class<? extends EntityT> |
getEntityClass()
Returns a class object of the type this fluent helper works with.
|
protected com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteRequestBuilder |
getQueryBuilder()
Deprecated.
|
FluentHelperT |
ignoreVersionIdentifier()
Deprecated.
Use
matchAnyVersionIdentifier() or disableVersionIdentifier() instead. |
FluentHelperT |
ignoringVersionIdentifier(boolean ignore)
Deprecated.
Use
matchAnyVersionIdentifier() or disableVersionIdentifier() instead. |
FluentHelperT |
matchAnyVersionIdentifier()
The delete request will ignore any version identifier present on the entity and delete the entity, regardless of
any changes on the remote entity.
|
com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteRequest |
toQuery()
Deprecated.
Use the improved method
toRequest() instead. |
ODataRequestDelete |
toRequest()
Translate this OData v2 request into a OData request object extending
ODataRequestGeneric . |
FluentHelperT |
withErrorHandler(com.sap.cloud.sdk.odatav2.connectivity.ErrorResultHandler<?> errorResultHandler)
Deprecated.
Obsolete, refer to
ODataException and its subclasses to achieve fine-grained separation of
error causes. |
FluentHelperT |
withoutCsrfToken()
Deactivates the CSRF token retrieval for this OData request.
|
and, cachingMetadata, getHeaders, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getParametersForRequestOnly, getServicePath, getThis, getVersionIdentifier, isCachingMetadata, onRequestAndImplicitRequests, onRequestOnly, withHeader, withHeaders, withoutCachingMetadata, withQueryParameter
public FluentHelperDelete(@Nonnull String servicePath)
servicePath
- The service path to direct the requests to.public FluentHelperDelete(@Nonnull String servicePath, @Nonnull String entityCollection)
servicePath
- The service path to direct the requests to.entityCollection
- The entity collection to direct the requests to.@Nonnull protected abstract EntityT getEntity()
executeRequest(HttpDestinationProperties)
method.@Nonnull protected Class<? extends EntityT> getEntityClass()
FluentHelperBasic
getEntityClass
in class FluentHelperBasic<FluentHelperT,EntityT extends VdmEntity<?>,com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteResult>
@Nonnull @Deprecated protected com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteRequestBuilder getQueryBuilder()
ODataDeleteRequestBuilder
based on the Entity class.
The following settings are necessary to build the ODataDeleteRequestBuilder
:
ODataDeleteRequestBuilder
.com.sap.cloud.sdk.odatav2.connectivity.ODataException
- if the key values of the entity could not be converted to the OData key values.@Nonnull @Deprecated public com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteRequest toQuery()
toRequest()
instead.com.sap.cloud.sdk.odatav2.connectivity.ODataException
- if the ODataDeleteRequest
could not be initialized.@Nonnull @Deprecated public FluentHelperT withErrorHandler(@Nonnull com.sap.cloud.sdk.odatav2.connectivity.ErrorResultHandler<?> errorResultHandler)
ODataException
and its subclasses to achieve fine-grained separation of
error causes.ErrorResultHandler
interface can be
attached to this fluent helper. This allows custom logic to be called when an error occurs in the
execute(HttpDestinationProperties)
method. If this method is not called, then an instance of
ODataVdmErrorResultHandler
is used. Only one handler can be attached at a time
per fluent helper object, so calling this multiple times will replace the handler.errorResultHandler
- Instance of an error handler class that implements the ErrorResultHandler
interface.@Nonnull @Deprecated public FluentHelperT ignoringVersionIdentifier(boolean ignore)
matchAnyVersionIdentifier()
or disableVersionIdentifier()
instead.Warning: Be careful with this option, as this might overwrite any changes made to the remote representation of this object.
ignore
- Boolean indicating whether the version identifier shall be ignored@Deprecated @Nonnull public FluentHelperT ignoreVersionIdentifier()
matchAnyVersionIdentifier()
or disableVersionIdentifier()
instead.Warning: Be careful with this option, as this might overwrite any changes made to the remote representation of this object.
@Nonnull public FluentHelperT disableVersionIdentifier()
Warning: This might lead to a response from the remote system that the `If-Match` header is missing.
It depends on the implementation of the remote system whether the `If-Match` header is expected.
@Nonnull public FluentHelperT matchAnyVersionIdentifier()
Warning: Be careful with this option, as this might overwrite any changes made to the remote representation of this object.
@Nonnull @Deprecated public com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteResult execute(@Nonnull HttpDestinationProperties destination) throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
executeRequest(HttpDestinationProperties)
instead.execute
in class FluentHelperBasic<FluentHelperT,EntityT extends VdmEntity<?>,com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteResult>
destination
- Supply the destination for executing the underlying OData query.com.sap.cloud.sdk.odatav2.connectivity.ODataException
- The exception occurred during request execution@Nonnull public ModificationResponse<EntityT> executeRequest(@Nonnull HttpDestinationProperties destination)
execute(HttpDestinationProperties)
. Contrary to
execute(HttpDestinationProperties)
this operation does not request the service metadata before
performing the actual request. As a consequence FluentHelperBasic.withoutCachingMetadata()
and FluentHelperBasic.cachingMetadata()
have no effect on this operation. Furthermore, error handlers registered via
withErrorHandler(ErrorResultHandler)
will not be respected.executeRequest
in interface FluentHelperExecutable<Object>
executeRequest
in class FluentHelperBasic<FluentHelperT,EntityT extends VdmEntity<?>,com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteResult>
destination
- The target system this request should be issued against.DestinationAccessException
- If there is an issue accessing the
HttpDestination
.HttpClientInstantiationException
- If there is an issue creating the HttpClient
.ODataException
- If the OData request execution failed. Please find the documentation for ODataException
possible sub-types and error scenarios they can occur in.@Beta @Nonnull public ODataRequestDelete toRequest()
FluentHelperBasic
ODataRequestGeneric
.@Nonnull public FluentHelperT withoutCsrfToken()
Copyright © 2021 SAP SE. All rights reserved.