Package com.sap.cloud.sdk.datamodel.odatav4.core

Class DeleteRequestBuilder<EntityT extends VdmEntity<?>>

java.lang.Object
com.sap.cloud.sdk.datamodel.odatav4.core.DeleteRequestBuilder<EntityT>
Type Parameters:
EntityT - The type of the entity to delete.
All Implemented Interfaces:
ModificationRequestBuilder<ModificationResponse<EntityT>>, RequestBuilder<ModificationResponse<EntityT>>, RequestBuilderExecutable<ModificationResponse<EntityT>>
public class DeleteRequestBuilder<EntityT extends VdmEntity<?>> extends Object implements ModificationRequestBuilder<ModificationResponse<EntityT>>
Representation of an OData delete request as a fluent interface for further configuring the request and executing it.

  • Field Details

  • Constructor Details

    • DeleteRequestBuilder

      public DeleteRequestBuilder(@Nonnull String servicePath, @Nonnull EntityT entity, @Nonnull String entityCollection)
      Instantiates this request builder using the given service path to send the requests.
      Parameters:
      servicePath - The service path to direct the requests to.
      entity - The entity to delete.
      entityCollection - The entity collection

  • Method Details

    • execute

      @Nonnull public ModificationResponse<EntityT> execute(@Nonnull Destination destination)
      Execute the OData delete request for the provided entity. Execute the OData request.
      Specified by:
      execute in interface RequestBuilderExecutable<EntityT extends VdmEntity<?>>
      Parameters:
      destination - The destination to be used as request target.
      Returns:
      The wrapped service response, exposing response headers, status code and entity references. If the HTTP response is not within healthy bounds, then one of the declared runtime exceptions will be thrown with further details.

    • toRequest

      @Nonnull public ODataRequestDelete toRequest()
      Creates an instance of the ODataRequestDelete based on the Entity class.

      The following settings are used:

      • the endpoint URL
      • the entity collection name
      • the key fields of the entity
      Specified by:
      toRequest in interface RequestBuilder<EntityT extends VdmEntity<?>>
      Returns:
      An initialized ODataRequestDelete.

    • disableVersionIdentifier

      @Nonnull public DeleteRequestBuilder<EntityT> disableVersionIdentifier()
      The delete request will ignore any version identifier present on the entity and not send an `If-Match` header.

      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.

      Returns:
      The same request builder that will not send the `If-Match` header in the delete request

    • matchAnyVersionIdentifier

      @Nonnull public 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.

      Warning: Be careful with this option, as this might overwrite any changes made to the remote representation of this object.

      Returns:
      The same request builder that will ignore the version identifier of the entity to delete

    • getEntityClass

      @Nonnull protected Class<EntityT> getEntityClass()
      Returns a class object of the type this request builder works with.
      Returns:
      A class object of the handled type.

    • withoutCsrfToken

      @Nonnull public DeleteRequestBuilder<EntityT> withoutCsrfToken()
      Description copied from interface: ModificationRequestBuilder
      Deactivates the CSRF token retrieval for this OData request. This is useful if the server does not support or require CSRF tokens as part of the request.
      Specified by:
      withoutCsrfToken in interface ModificationRequestBuilder<EntityT extends VdmEntity<?>>
      Returns:
      The same builder

    • getEntity

      @Nonnull protected EntityT getEntity()
      The entity object to be deleted by calling the execute(Destination) method.

    • getThis

      @Nonnull protected DeleteRequestBuilder<EntityT> getThis()
      Get the reference to this instance.
      Returns:
      The FluentHelper instance.

    • withListener

      @Nonnull public DeleteRequestBuilder<EntityT> withListener(@Nonnull ODataRequestListener listener)
      An error handling class that implements the error result handler interface can be attached to this request builder. This allows custom logic to be called when an error occurs in the 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 request builder object, so calling this multiple times will replace the handler.
      Parameters:
      listener - Instance of an error handler class that implements the error result handler interface.
      Returns:
      The same request builder with its error handler set to the provided object.

    • withHeader

      @Nonnull public DeleteRequestBuilder<EntityT> withHeader(@Nonnull String key, @Nullable String value)
      Description copied from interface: RequestBuilder
      Gives the option to specify custom HTTP headers. Multiple headers with the same key can be specified. The returned object allows to specify the requests the headers should be used in.
      Specified by:
      withHeader in interface RequestBuilder<BuilderT extends RequestBuilder<ResultT>>
      Parameters:
      key - Name of the (first) desired HTTP header parameter.
      value - Value of the (first) desired HTTP header parameter.
      Returns:
      A request builder to specify further headers and their intended usage.

    • withHeaders

      @Nonnull public DeleteRequestBuilder<EntityT> withHeaders(@Nonnull Map<String,String> map)
      Description copied from interface: RequestBuilder
      Gives the option to specify a map of custom HTTP headers. The returned object allows to specify the requests the headers should be used in.
      Specified by:
      withHeaders in interface RequestBuilder<BuilderT extends RequestBuilder<ResultT>>
      Parameters:
      map - A map of HTTP header key/value pairs.
      Returns:
      A request builder to specify further headers and their intended usage.

    • withQueryParameter

      @Nonnull public DeleteRequestBuilder<EntityT> withQueryParameter(@Nonnull String key, @Nullable String value)
      Gives the option to specify custom query parameters for the request.

      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 request builder 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")

      Parameters:
      key - Name of the query parameter.
      value - Value of the query parameter.
      Returns:
      The same request builder.

    • getServicePath

      @Nonnull protected String getServicePath()

    • getResourcePath

      @Nonnull protected ODataResourcePath getResourcePath()

    • getHeaders

      @Nonnull protected Map<String,Collection<String>> getHeaders()
      A map containing the headers to be used only for the actual request of this FluentHelper implementation.

    • getParametersForRequestOnly

      @Nonnull protected Map<String,String> getParametersForRequestOnly()
      A map containing the custom query parameters to be used only for the actual request of this FluentHelper implementation.

    • getListeners

      @Nonnull protected List<ODataRequestListener> getListeners()