EntityT
- The type of the entity to delete.public class DeleteRequestBuilder<EntityT extends VdmEntity<?>> extends Object implements ModifyingOperation
executing
it.Modifier | Constructor and Description |
---|---|
|
DeleteRequestBuilder(String servicePath,
EntityT entity)
Instantiates this fluent helper using the given service path to send the requests.
|
protected |
DeleteRequestBuilder(String servicePath,
EntityT entity,
ODataEntityKey entityKey)
Instantiates this fluent helper using the given service path to send the requests.
|
Modifier and Type | Method and Description |
---|---|
DeleteRequestBuilder<EntityT> |
disableVersionIdentifier()
The delete request will ignore any version identifier present on the entity and not send an `If-Match` header.
|
ModificationResponse<EntityT> |
execute(HttpDestinationProperties destination)
Execute the OData delete request for the provided entity.
|
protected EntityT |
getEntity()
The entity object to be deleted by calling the
execute(HttpDestinationProperties) method. |
protected Class<EntityT> |
getEntityClass()
Returns a class object of the type this fluent helper works with.
|
protected ODataEntityKey |
getEntityKey() |
protected Map<String,String> |
getHeaders()
A map containing the headers to be used only for the actual request of this FluentHelper implementation.
|
protected List<ODataRequestListener> |
getListeners() |
protected Map<String,String> |
getParametersForRequestOnly()
A map containing the custom query parameters to be used only for the actual request of this FluentHelper
implementation.
|
protected String |
getServicePath() |
protected FluentHelperT |
getThis()
Get the reference to this instance.
|
DeleteRequestBuilder<EntityT> |
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.
|
ODataRequestDelete |
toRequest()
Creates an instance of the
ODataRequestDelete based on the Entity class. |
io.vavr.control.Try<ResultT> |
tryExecute(HttpDestinationProperties destination)
Safely execute the OData request.
|
FluentHelperT |
withHeader(String key,
String value)
Gives the option to specify custom HTTP headers.
|
FluentHelperT |
withHeaders(Map<String,String> map)
Gives the option to specify a map of custom HTTP headers.
|
FluentHelperT |
withListener(ODataRequestListener listener)
An error handling class that implements the error result handler interface can be attached to this fluent helper.
|
FluentHelperT |
withQueryParameter(String key,
String value)
Gives the option to specify custom query parameters for the request.
|
public DeleteRequestBuilder(@Nonnull String servicePath, @Nonnull EntityT entity)
servicePath
- The service path to direct the requests to.entity
- The entity to delete.protected DeleteRequestBuilder(@Nonnull String servicePath, @Nonnull EntityT entity, @Nonnull ODataEntityKey entityKey)
servicePath
- The service path to direct the requests to.entity
- The entity to delete.entityKey
- The OData entity key.@Nonnull public ModificationResponse<EntityT> execute(@Nonnull HttpDestinationProperties destination)
destination
- The destination to be used as request target.@Nonnull @Beta public ODataRequestDelete toRequest()
ODataRequestDelete
based on the Entity class.
The following settings are used:
ODataRequestDelete
.@Nonnull public DeleteRequestBuilder<EntityT> 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 DeleteRequestBuilder<EntityT> matchAnyVersionIdentifier()
Warning: Be careful with this option, as this might overwrite any changes made to the remote representation of this object.
@Nonnull protected Class<EntityT> getEntityClass()
@Nonnull protected EntityT getEntity()
execute(HttpDestinationProperties)
method.@Nonnull protected ODataEntityKey getEntityKey()
@Nonnull protected FluentHelperT getThis()
@Nonnull public io.vavr.control.Try<ResultT> tryExecute(@Nonnull HttpDestinationProperties destination)
destination
- The destination to be used as request target.Try
block.@Nonnull @Beta public FluentHelperT withListener(@Nonnull ODataRequestListener listener)
execute
method. If this method
is not called, then an instance of ODataRequestListener is used. Only one handler can be attached at a time per
fluent helper object, so calling this multiple times will replace the handler.listener
- Instance of an error handler class that implements the error result handler interface.@Nonnull @Beta public FluentHelperT withHeader(@Nonnull String key, @Nullable String value)
key
- Name of the (first) desired HTTP header parameter.value
- Value of the (first) desired HTTP header parameter.@Nonnull @Beta public FluentHelperT withHeaders(@Nonnull Map<String,String> map)
map
- A map of HTTP header key/value pairs.@Nonnull @Beta public FluentHelperT withQueryParameter(@Nonnull String key, @Nullable String value)
Note: It is recommended to only use this function for query parameters which are not supported by the VDM by default. Using this function to bypass fluent helper method calls can lead to unsupported response handling. There is no contract on the order or priority of parameters added to the request.
Example: Use the request query option $search
to reduce the result set, leaving
only entities which match the specified search expression. This feature is supported in protocol OData v4.
new DefaultBusinessPartnerService().getAllBusinessPartner().withQueryParameter("$search", "Köln OR Cologne")
key
- Name of the query parameter.value
- Value of the query parameter.@Nonnull protected Map<String,String> getHeaders()
@Nonnull protected Map<String,String> getParametersForRequestOnly()
@Nonnull protected List<ODataRequestListener> getListeners()
Copyright © 2020 SAP SE. All rights reserved.