Package com.sap.cloud.sdk.datamodel.odata.helper

Class FluentHelperDelete<FluentHelperT,EntityT extends VdmEntity<?>>

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperBasic<FluentHelperT,EntityT,ModificationResponse<EntityT>>

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperModification<FluentHelperT,EntityT>

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperDelete<FluentHelperT,EntityT>

Type Parameters:

FluentHelperT - The fluent helper type.

EntityT - The type of the entity to delete.

All Implemented Interfaces:

FluentHelperExecutable<Object>

public abstract class FluentHelperDelete<FluentHelperT,EntityT extends VdmEntity<?>>
extends FluentHelperModification<FluentHelperT,EntityT>

Representation of an OData delete request as a fluent interface for further configuring the request and executing it.

Field Summary

Fields inherited from class com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperBasic

csrfTokenRetriever, entityCollection

Constructor Summary

Constructors

Constructor	Description
FluentHelperDelete(String servicePath, String entityCollection)	Instantiates this fluent helper using the given service path and entity collection to send the requests.

Method Summary

Modifier and Type	Method	Description
FluentHelperT	disableVersionIdentifier()	The delete request will ignore any version identifier present on the entity and not send an `If-Match` header.
ModificationResponse<EntityT>	executeRequest(Destination destination)	Executes this request.
protected abstract EntityT	getEntity()	The entity object to be deleted by calling the executeRequest(Destination) method.
protected Class<? extends EntityT>	getEntityClass()	Returns a class object of the type this fluent helper works with.
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.
ODataRequestDelete	toRequest()	Translate this OData v2 request into a OData request object extending ODataRequestGeneric.

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperModification

withoutCsrfToken

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperBasic

getCsrfTokenRetriever, getHeaders, getParametersForRequestOnly, getServicePath, getThis, withHeader, withHeaders, withQueryParameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FluentHelperDelete

public FluentHelperDelete(@Nonnull
 String servicePath,
 @Nonnull
 String entityCollection)

Instantiates this fluent helper using the given service path and entity collection to send the requests.

Parameters:

servicePath - The service path to direct the requests to.

entityCollection - The entity collection to direct the requests to.

Method Details

getEntity

@Nonnull
protected abstract EntityT getEntity()

The entity object to be deleted by calling the executeRequest(Destination) method.

Returns:

The entity to be deleted.

getEntityClass

@Nonnull
protected Class<? extends EntityT> getEntityClass()

Description copied from class: FluentHelperBasic

Returns a class object of the type this fluent helper works with.

Specified by:

getEntityClass in class FluentHelperBasic<FluentHelperT,EntityT extends VdmEntity<?>,ModificationResponse<EntityT extends VdmEntity<?>>>

Returns:

A class object of the handled type.

disableVersionIdentifier

@Nonnull
public FluentHelperT 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 update request

matchAnyVersionIdentifier

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

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 update

executeRequest

@Nonnull
public ModificationResponse<EntityT> executeRequest(@Nonnull
 Destination destination)

Description copied from interface: FluentHelperExecutable

Executes this request.

Specified by:

executeRequest in interface FluentHelperExecutable<FluentHelperT>

Specified by:

executeRequest in class FluentHelperBasic<FluentHelperT,EntityT extends VdmEntity<?>,ModificationResponse<EntityT extends VdmEntity<?>>>

Parameters:

destination - The target system this request should be issued against.

Returns:

A response according to the query criteria.

toRequest

@Nonnull
public ODataRequestDelete toRequest()

Description copied from class: FluentHelperBasic

Translate this OData v2 request into a OData request object extending ODataRequestGeneric.

Specified by:

toRequest in class FluentHelperBasic<FluentHelperT,EntityT extends VdmEntity<?>,ModificationResponse<EntityT extends VdmEntity<?>>>

Returns:

A protocol agnostic OData request instance.