com.sap.cloud.sdk.odatav2.connectivity.api

Interface IQueryBuilder

All Known Implementing Classes:

ODataQueryBuilder

public interface IQueryBuilder

Method Summary

Modifier and Type	Method and Description
IODataQuery	build() Builds an OData query from this builder.
IQueryBuilder	enableMetadataCache() Enables caching of the metadata of an OData V2 data source.
IQueryBuilder	enableMetadataCache(com.sap.cloud.sdk.cloudplatform.cache.CacheKey cacheKey) Enables caching of the metadata of an OData V2 data source.
IQueryBuilder	expand(String... expands) Selects navigation properties to expand.
IQueryBuilder	filter(FilterExpression filter) Adds a Filter expression to the OData query.
IQueryBuilder	inlineCount() Sets $inlinecount=allpages as a query parameter.
IQueryBuilder	keys(Map<String,Object> keys)
IQueryBuilder	navigateTo(String navigation) Adds navigation Property to the URL.
IQueryBuilder	param(String key, Object value) Adds a query parameter to the OData request.
IQueryBuilder	select(List<String> selects) Selects properties to read.
IQueryBuilder	select(String... selects) Selects properties to read.
IQueryBuilder	skip(Integer n) Sets skip value.
IQueryBuilder	top(Integer n) Sets top value.
IQueryBuilder	useMetadata(boolean useMetadata)
IQueryBuilder	withCacheRefresh() Replaces the existing metadata in the cache with the latest version from the OData V2 data source.
IQueryBuilder	withHeader(String key, String value) Adds a header to the query request.
IQueryBuilder	withHeader(String key, String value, boolean passInAllRequests) Adds a header to the query request and optionally to the metadata request as well depending on the value of the passInAllRequests parameter.
IQueryBuilder	withMetadata(URL metadataFilePath) Gets the metadata from the specified path.
IQueryBuilder	withoutMetadata() Used to tell the framework to not get the metadata before the actual query.

Method Detail

select

IQueryBuilder select(String... selects)

Selects properties to read.

Parameters:

selects - The list of properties to be read.

Returns:

ODataQueryBuilder

select

IQueryBuilder select(List<String> selects)

Selects properties to read.

Parameters:

selects - of type List- The list of properties to be read.

Returns:

ODataQueryBuilder

enableMetadataCache

IQueryBuilder 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:

ODataQueryBuilder

enableMetadataCache

IQueryBuilder 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:

ODataQueryBuilder

withCacheRefresh

IQueryBuilder withCacheRefresh()

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

Returns:

ODataQueryBuilder

withMetadata

IQueryBuilder withMetadata(URL metadataFilePath)

Gets the metadata from the specified path.

Parameters:

metadataFilePath - URL pointing to the metadata information

Returns:

ODataQueryBuilder A builder for forming the Create

withHeader

IQueryBuilder withHeader(String key,
                         String value)

Adds a header to the query request.

Parameters:

key - name of the header

value - value of the header

Returns:

ODataQueryBuilder

withHeader

IQueryBuilder withHeader(String key,
                         String value,
                         boolean passInAllRequests)

Adds a header to the query 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 etc. made as part of the Query Request call.

Returns:

ODataQueryBuilder

inlineCount

IQueryBuilder inlineCount()

Sets $inlinecount=allpages as a query parameter.

Returns:

ODataQueryBuilder

expand

IQueryBuilder expand(String... expands)

Selects navigation properties to expand.

Parameters:

expands - List of navigation properties to expand

Returns:

ODataQueryBuilder

top

IQueryBuilder top(Integer n)

Sets top value.

Parameters:

n - the top value required

Returns:

ODataQueryBuilder

skip

IQueryBuilder skip(Integer n)

Sets skip value.

Parameters:

n - the skip value required

Returns:

ODataQueryBuilder

filter

IQueryBuilder filter(FilterExpression filter)

Adds a Filter expression to the OData query.

Parameters:

filter - Object of FilterExpression that represents an OData filter expression.

Returns:

ODataQueryBuilder

param

IQueryBuilder param(String key,
                    Object value)

Adds a query parameter to the OData request.

Parameters:

key -

value -

Returns:

ODataQueryBuilder

withoutMetadata

IQueryBuilder withoutMetadata()

Used to tell the framework to not get the metadata before the actual query. This is not honoured if keys are set or if filter is set because the framework uses metadata for these use cases.

Returns:

build

IODataQuery build()

Builds an OData query from this builder.

Returns:

ODataQuery

navigateTo

IQueryBuilder navigateTo(String navigation)

Adds navigation Property to the URL.

Parameters:

Navigation - property name to be added

Returns:

IQueryBuilder

keys

IQueryBuilder keys(Map<String,Object> keys)

useMetadata

IQueryBuilder useMetadata(boolean useMetadata)