com.sap.cloud.sdk.odatav2.connectivity

Class ODataCreateRequestBuilder

java.lang.Object

com.sap.cloud.sdk.odatav2.connectivity.ODataCreateRequestBuilder

public class ODataCreateRequestBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
ODataCreateRequest	build() Builds an ODataCreateRequest from this builder.
ODataCreateRequestBuilder	enableMetadataCache() Enables caching of the metadata of an OData V2 data source.
ODataCreateRequestBuilder	enableMetadataCache(com.sap.cloud.sdk.cloudplatform.cache.CacheKey cacheKey) Enables caching of the metadata of an OData V2 data source.
ODataCreateRequestBuilder	onNavigationProperty(String navigationProperty, Map<String,Object> keyMap) Creates an entity related to a source entity using the navigation property.
ODataCreateRequestBuilder	withBody(Map<String,Object> entityData) Deprecated.
ODataCreateRequestBuilder	withBodyAs(Object pojoData) This method is used to create the request body based on a POJO object
ODataCreateRequestBuilder	withBodyAsMap(Map<String,Object> entityData) Sets the passed map for the payload of an OData create request.
ODataCreateRequestBuilder	withCacheRefresh() Replaces the existing metadata in the cache with the latest version from the OData V2 data source.
static ODataCreateRequestBuilder	withEntity(String serviceName, String entitySetName) Creates an ODataCreateRequestBuilder with the given service and entity name.
ODataCreateRequestBuilder	withErrorHandler(ErrorResultHandler<?> errorHandler) Sets an error handler to this ODataCreateRequestBuilder.
ODataCreateRequestBuilder	withHeader(String key, String value) Adds a header to the create request.
ODataCreateRequestBuilder	withHeader(String key, String value, boolean passInAllRequests) Adds a header to the create request and optionally to the metadata request as well depending on the value of the passInAllRequests parameter.
ODataCreateRequestBuilder	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

withEntity

public static ODataCreateRequestBuilder withEntity(String serviceName,
                                                   String entitySetName)

Creates an ODataCreateRequestBuilder with the given service and entity name.

Parameters:

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

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

Returns:

ODataCreateRequestBuilder

withBody

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

Deprecated.

withBodyAsMap

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

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

Parameters:

entityData -

Returns:

ODataCreateRequestBuilder

withErrorHandler

public ODataCreateRequestBuilder withErrorHandler(ErrorResultHandler<?> errorHandler)

Sets an error handler to this ODataCreateRequestBuilder.

Parameters:

errorHandler -

Returns:

ODataCreateRequestBuilder

withHeader

public ODataCreateRequestBuilder withHeader(String key,
                                            String value)

Adds a header to the create request.

Parameters:

key - name of the header

value - value of the header

Returns:

ODataCreateRequestBuilder

withHeader

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

Adds a header to the create 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:

ODataQueryBuilder

enableMetadataCache

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

ODataCreateRequestBuilder

withCacheRefresh

public ODataCreateRequestBuilder withCacheRefresh()

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

Returns:

ODataCreateRequestBuilder

withMetadata

public ODataCreateRequestBuilder withMetadata(URL metadataFilePath)

Gets the metadata from the specified path.

Parameters:

metadataFilePath - URL pointing to the metadata information

Returns:

ODataCreateRequestBuilder A builder for forming the Create

build

public ODataCreateRequest build()

Builds an ODataCreateRequest from this builder.

Returns:

an ODataCreateRequest object.

withBodyAs

public ODataCreateRequestBuilder 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 ODataCreateRequestBuilder

onNavigationProperty

public ODataCreateRequestBuilder onNavigationProperty(String navigationProperty,
                                                      Map<String,Object> keyMap)

Creates an entity related to a source entity using the navigation property. For this to work, in the OData model, the association referred by the navigation property must be contained in an association set.

Parameters:

navigationProperty - Navigation property of the source entity

keyMap - Key of the source entity, which can also be a composite key

Returns:

An ODataCreateRequestBuilder object