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.
|
Modifier and Type | Method and Description |
---|---|
com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteResult |
execute(HttpDestinationProperties destination)
Executes the underlying delete request.
|
protected abstract EntityT |
getEntity()
The entity object to be deleted by calling the
execute(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()
Creates an instance of the
ODataDeleteRequestBuilder based on the Entity class. |
FluentHelperT |
ignoreVersionIdentifier()
The delete request will ignore the given version identifier and deletes the entity, regardless of any changes on
the remote entity.
|
FluentHelperT |
ignoringVersionIdentifier(boolean ignore)
You can specify whether the given version identifier shall be ignored and, as a consequence, the deletion of the
remote entity shall be executed in any case regardless of any previous changes on the remote entity.
|
com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteRequest |
toQuery()
Provides access to the underlying Query object, to allow for custom integration scenarios not yet supported by
the virtual data model.
|
FluentHelperT |
withErrorHandler(com.sap.cloud.sdk.odatav2.connectivity.ErrorResultHandler<?> errorResultHandler)
An error handling class that implements the
ErrorResultHandler interface can be
attached to this fluent helper. |
cachingMetadata, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getParametersForRequestOnly, getServicePath, getThis, getVersionIdentifier, isCachingMetadata, withHeader, withHeaders, withoutCachingMetadata, withQueryParameter
@Nonnull protected abstract EntityT getEntity()
execute(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 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 public com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteRequest toQuery()
com.sap.cloud.sdk.odatav2.connectivity.ODataException
- if the ODataDeleteRequest
could not be initialized.@Nonnull public FluentHelperT withErrorHandler(@Nonnull com.sap.cloud.sdk.odatav2.connectivity.ErrorResultHandler<?> errorResultHandler)
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 public FluentHelperT ignoringVersionIdentifier(boolean ignore)
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@Nonnull public FluentHelperT ignoreVersionIdentifier()
Warning: Be careful with this option, as this might overwrite any changes made to the remote representation of this object.
@Nonnull public com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteResult execute(@Nonnull HttpDestinationProperties destination) throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
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
Copyright © 2019 SAP SE. All rights reserved.