com.sap.cloud.sdk.odatav2.connectivity.batch

Class BatchRequestBuilder

java.lang.Object

com.sap.cloud.sdk.odatav2.connectivity.batch.BatchRequestBuilder

public class BatchRequestBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
BatchRequestBuilder	addChangeSet(ChangeSet changeSet) Adds a change set request to the batch.
BatchRequestBuilder	addQueryRequest(ODataQuery queryRequest) Adds a query request to the batch.
BatchRequest	build() Builds an BatchRequest from this builder.
BatchRequestBuilder	enableMetadataCache() Enables caching of the metadata of an OData V2 data source.
BatchRequestBuilder	enableMetadataCache(com.sap.cloud.sdk.cloudplatform.cache.CacheKey cacheKey) Enables caching of the metadata of an OData V2 data source.
BatchRequestBuilder	withCacheRefresh() Replaces the existing metadata in the cache with the latest version from the OData V2 data source.
BatchRequestBuilder	withErrorHandler(ErrorResultHandler<?> errorHandler) Sets an error handler in this BatchRequestBuilder.
BatchRequestBuilder	withHeader(String key, String value) Adds a header to the batch request.
BatchRequestBuilder	withHeader(String key, String value, boolean passInAllRequests) Adds a header to the batch request and optionally to the metadata request as well depending on the value of the passInAllRequests parameter.
BatchRequestBuilder	withMetadata(URL metadataFilePath) Gets the metadata from the specified path.
static BatchRequestBuilder	withService(String serviceName) Specifies the service where the batch request will be executed.

Methods inherited from class java.lang.Object

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

Method Detail

build

public BatchRequest build()

Builds an BatchRequest from this builder.

Returns:

an BatchRequest object.

addQueryRequest

public BatchRequestBuilder addQueryRequest(ODataQuery queryRequest)

Adds a query request to the batch.

Parameters:

queryRequest - Represents the query request

Returns:

BatchRequestBuilder

addChangeSet

public BatchRequestBuilder addChangeSet(ChangeSet changeSet)

Adds a change set request to the batch.

Parameters:

changeSet - Represents the change set

Returns:

BatchRequestBuilder

withService

public static BatchRequestBuilder withService(String serviceName)

Specifies the service where the batch request will be executed.

Parameters:

serviceName - Name of the OData service

Returns:

BatchRequestBuilder

withHeader

public BatchRequestBuilder withHeader(String key,
                                      String value)

Adds a header to the batch request.

Parameters:

key - name of the header

value - value of the header

Returns:

BatchRequestBuilder

withHeader

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

Adds a header to the batch 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 Create Request call

Returns:

BatchRequestBuilder

withErrorHandler

public BatchRequestBuilder withErrorHandler(ErrorResultHandler<?> errorHandler)

Sets an error handler in this BatchRequestBuilder.

Parameters:

errorHandler -

Returns:

BatchRequestBuilder

enableMetadataCache

public BatchRequestBuilder 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:

ODataCreateRequestBuilder

enableMetadataCache

public BatchRequestBuilder 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 and other parameters in the cache key.

Returns:

BatchRequestBuilder

withCacheRefresh

public BatchRequestBuilder withCacheRefresh()

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

Returns:

BatchRequestBuilder

withMetadata

public BatchRequestBuilder withMetadata(URL metadataFilePath)

Gets the metadata from the specified path.

Parameters:

metadataFilePath - URL pointing to the metadata information

Returns:

BatchRequestBuilder A builder for forming the Create