com.sap.cloud.sdk.odatav2.connectivity

Class ODataDeleteRequestBuilder

java.lang.Object

com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteRequestBuilder

public class ODataDeleteRequestBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
ODataDeleteRequest	build() Builds an ODataDeleteRequest from this builder.
ODataDeleteRequestBuilder	enableMetadataCache() Enables caching of the metadata of an OData V2 data source.
ODataDeleteRequestBuilder	enableMetadataCache(com.sap.cloud.sdk.cloudplatform.cache.CacheKey cacheKey) Enables caching of the metadata of an OData V2 data source.
ODataDeleteRequestBuilder	withCacheRefresh() Replaces the existing metadata in the cache with the latest version from the OData V2 data source.
static ODataDeleteRequestBuilder	withEntity(String serviceName, String entitySetName, Map<String,Object> keys) Creates an ODataDeleteRequestBuilder with the given service and entity name.
ODataDeleteRequestBuilder	withErrorHandler(ErrorResultHandler<?> errorHandler) Sets an error handler to this ODataDeleteRequestBuilder.
ODataDeleteRequestBuilder	withHeader(String key, String value)
ODataDeleteRequestBuilder	withHeader(String key, String value, boolean passInAllRequests) Adds a header to the delete request and optionally to the metadata request as well depending on the value of the passInAllRequests parameter.
ODataDeleteRequestBuilder	withMetadata(URL metadataFilePath) Gets the metadata from the specified path.

Methods inherited from class java.lang.Object

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

Method Detail

withErrorHandler

public ODataDeleteRequestBuilder withErrorHandler(ErrorResultHandler<?> errorHandler)

Sets an error handler to this ODataDeleteRequestBuilder.

Parameters:

errorHandler -

Returns:

ODataCreateRequestBuilder

enableMetadataCache

public ODataDeleteRequestBuilder enableMetadataCache()

Enables caching of the metadata of an OData V2 data source. If your application is running on a tenant, then the tenant ID along with the metadata URL is used to form the cache key.

Returns:

ODataDeleteRequestBuilder

enableMetadataCache

public ODataDeleteRequestBuilder enableMetadataCache(com.sap.cloud.sdk.cloudplatform.cache.CacheKey cacheKey)

Enables caching of the metadata of an OData V2 data source.

Parameters:

key - Cache key containing the ID of the tenant where the application runs. You can also include the user name in the cache key.

Returns:

ODataDeleteRequestBuilder

withCacheRefresh

public ODataDeleteRequestBuilder withCacheRefresh()

Replaces the existing metadata in the cache with the latest version from the OData V2 data source.

Returns:

ODataDeleteRequestBuilder

withMetadata

public ODataDeleteRequestBuilder withMetadata(URL metadataFilePath)

Gets the metadata from the specified path.

Parameters:

metadataFilePath - URL pointing to the metadata information

Returns:

ODataDeleteRequestBuilder A builder for forming the Create

withEntity

public static ODataDeleteRequestBuilder withEntity(String serviceName,
                                                   String entitySetName,
                                                   Map<String,Object> keys)

Creates an ODataDeleteRequestBuilder with the given service and entity name.

Parameters:

serviceName - name of the odata service where the developer wants to execute a delete operation.

entitySetName - name of the entity set, on which the developer wants to execute a delete operation

keys - keys identifying a particular entity

Returns:

ODataDeleteRequestBuilder

withHeader

public ODataDeleteRequestBuilder withHeader(String key,
                                            String value)

withHeader

public ODataDeleteRequestBuilder withHeader(String key,
                                            String value,
                                            boolean passInAllRequests)

Adds a header to the delete request and optionally to the metadata request as well depending on the value of the passInAllRequests parameter.

Parameters:

key - name of the header

value - value of the header

passInAllRequests - boolean indicating whether the header is to be passed in all the requests to the backend like $metadata call, CSRF Token fetch etc. made as part of the Delete Request call

Returns:

ODataQueryBuilder

build

public ODataDeleteRequest build()

Builds an ODataDeleteRequest from this builder.

Returns:

ODataDeleteRequest