com.sap.cloud.sdk.odatav2.connectivity

Class ODataUpdateRequestBuilder

java.lang.Object

com.sap.cloud.sdk.odatav2.connectivity.ODataUpdateRequestBuilder

public class ODataUpdateRequestBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
ODataUpdateRequest	build() Builds an ODataUpdateRequest from this builder.
ODataUpdateRequestBuilder	enableMetadataCache() Use this API to disable metadata caching.
ODataUpdateRequestBuilder	enableMetadataCache(com.sap.cloud.sdk.cloudplatform.cache.CacheKey cacheKey) Enables caching of the metadata of an OData V2 data source.
ODataUpdateRequestBuilder	withBody(Map<String,Object> entityData) Deprecated.
ODataUpdateRequestBuilder	withBodyAs(Object pojoData) This method is used to create the request body based on a POJO object
ODataUpdateRequestBuilder	withBodyAsMap(Map<String,Object> entityData) Sets the passed map for the payload of an OData update request.
ODataUpdateRequestBuilder	withCacheRefresh() Replaces the existing metadata in the cache with the latest version from the OData V2 data source.
static ODataUpdateRequestBuilder	withEntity(String serviceName, String entitySetName, Map<String,Object> keys) Creates an ODataUpdateRequestBuilder with the given service and entity name.
ODataUpdateRequestBuilder	withErrorHandler(ErrorResultHandler<?> errorHandler) Sets an error handler to this ODataUpdateRequestBuilder.
ODataUpdateRequestBuilder	withHeader(String key, String value) Adds a header to the update request.
ODataUpdateRequestBuilder	withHeader(String key, String value, boolean passInAllRequests) Adds a header to the update request and optionally to the metadata request as well depending on the value of the passInAllRequests parameter.
ODataUpdateRequestBuilder	withMetadata(URL metadataFilePath) Enables caching of the metadata of an OData V2 data source.

Methods inherited from class java.lang.Object

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

Method Detail

withEntity

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

Creates an ODataUpdateRequestBuilder with the given service and entity name.

Parameters:

serviceName - name of the odata service where the developer wants to execute an update operation.

entitySetName - name of the entity set, on which the developer wants to execute an update operation

keys - keys identifying a particular entity

Returns:

ODataUpdateRequestBuilder

withHeader

public ODataUpdateRequestBuilder withHeader(String key,
                                            String value)

Adds a header to the update request.

Parameters:

key - name of the header

value - value of the header

Returns:

ODataUpdateRequestBuilder

withHeader

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

Adds a header to the update 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 Update Request call.

Returns:

ODataQueryBuilder

withBody

@Deprecated
public ODataUpdateRequestBuilder withBody(Map<String,Object> entityData)

Deprecated.

enableMetadataCache

public ODataUpdateRequestBuilder enableMetadataCache()

Use this API to disable metadata caching. If used then metadata is fetched for every request.

Returns:

ODataUpdateRequestBuilder

enableMetadataCache

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

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:

ODataUpdateRequestBuilder

withCacheRefresh

public ODataUpdateRequestBuilder withCacheRefresh()

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

Returns:

ODataUpdateRequestBuilder

withMetadata

public ODataUpdateRequestBuilder withMetadata(URL metadataFilePath)

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:

ODataUpdateRequestBuilder A builder for forming the Create

withBodyAsMap

public ODataUpdateRequestBuilder withBodyAsMap(Map<String,Object> entityData)

Sets the passed map for the payload of an OData update request.

Parameters:

entityData -

Returns:

ODataCreateRequestBuilder

withErrorHandler

public ODataUpdateRequestBuilder withErrorHandler(ErrorResultHandler<?> errorHandler)

Sets an error handler to this ODataUpdateRequestBuilder.

Parameters:

errorHandler -

Returns:

ODataCreateRequestBuilder

build

public ODataUpdateRequest build()

Builds an ODataUpdateRequest from this builder.

Returns:

ODataUpdateRequest

withBodyAs

public ODataUpdateRequestBuilder withBodyAs(Object pojoData)

This method is used to create the request body based on a POJO object

Parameters:

pojoData - - An instance of POJO class

Returns:

A ODataUpdateRequestBuilder