EntityT
- The generic entity type.public class CountRequestBuilder<EntityT extends VdmEntity<?>> extends Object implements QuerySerializable
executing
it.Constructor and Description |
---|
CountRequestBuilder(String servicePath,
Class<EntityT> entityClass)
Instantiates this fluent helper using the given service path to send the requests.
|
Modifier and Type | Method and Description |
---|---|
Long |
execute(HttpDestinationProperties destination)
Execute the OData request.
|
CountRequestBuilder<EntityT> |
filter(FilterableBoolean<EntityT>... filters)
Filter on properties of EntityT.
|
String |
getEncodedQueryString()
Return the string representation of the underlying request that is being build by this fluent helper.
|
protected Class<EntityT> |
getEntityClass()
Returns a class object of the type this fluent helper works with.
|
protected Map<String,String> |
getHeaders()
A map containing the headers to be used only for the actual request of this FluentHelper implementation.
|
protected List<ODataRequestListener> |
getListeners() |
protected Map<String,String> |
getParametersForRequestOnly()
A map containing the custom query parameters to be used only for the actual request of this FluentHelper
implementation.
|
String |
getQueryString()
Compute the string representation of this query
|
protected String |
getServicePath() |
protected FluentHelperT |
getThis()
Get the reference to this instance.
|
CountRequestBuilder<EntityT> |
search(SearchExpression expression)
Request modifier to return the set of entities corresponding to the specified boolean expression.
|
CountRequestBuilder<EntityT> |
search(String search)
Request modifier to return the set of entities that contain the specified value.
|
ODataRequestCount |
toRequest()
Creates an instance of the
ODataRequestCount based on the Entity class. |
io.vavr.control.Try<ResultT> |
tryExecute(HttpDestinationProperties destination)
Safely execute the OData request.
|
FluentHelperT |
withHeader(String key,
String value)
Gives the option to specify custom HTTP headers.
|
FluentHelperT |
withHeaders(Map<String,String> map)
Gives the option to specify a map of custom HTTP headers.
|
FluentHelperT |
withListener(ODataRequestListener listener)
An error handling class that implements the error result handler interface can be attached to this fluent helper.
|
FluentHelperT |
withQueryParameter(String key,
String value)
Gives the option to specify custom query parameters for the request.
|
public CountRequestBuilder(@Nonnull String servicePath, @Nonnull Class<EntityT> entityClass)
servicePath
- The service path to direct the requests to.entityClass
- The expected entity type.@Nonnull @Beta public ODataRequestCount toRequest()
ODataRequestCount
based on the Entity class.
The following settings are used:
ODataRequestCount
.@Nonnull @Beta public String getEncodedQueryString()
getEncodedQueryString
in interface QuerySerializable
@Nonnull @Beta public String getQueryString()
QuerySerializable
getQueryString
in interface QuerySerializable
@Nonnull public Long execute(@Nonnull HttpDestinationProperties destination)
destination
- The destination to be used as request target.@SafeVarargs @Nonnull public final CountRequestBuilder<EntityT> filter(@Nonnull FilterableBoolean<EntityT>... filters)
filters
- Filter expressions to be added to the request.@Nonnull public CountRequestBuilder<EntityT> search(@Nonnull String search)
search
- A string value as the search criteria.@Nonnull public CountRequestBuilder<EntityT> search(@Nonnull SearchExpression expression)
expression
- SearchExpression as the search criteriaprotected Class<EntityT> getEntityClass()
@Nonnull protected FluentHelperT getThis()
@Nonnull public io.vavr.control.Try<ResultT> tryExecute(@Nonnull HttpDestinationProperties destination)
destination
- The destination to be used as request target.Try
block.@Nonnull @Beta public FluentHelperT withListener(@Nonnull ODataRequestListener listener)
execute
method. If this method
is not called, then an instance of ODataRequestListener is used. Only one handler can be attached at a time per
fluent helper object, so calling this multiple times will replace the handler.listener
- Instance of an error handler class that implements the error result handler interface.@Nonnull @Beta public FluentHelperT withHeader(@Nonnull String key, @Nullable String value)
key
- Name of the (first) desired HTTP header parameter.value
- Value of the (first) desired HTTP header parameter.@Nonnull @Beta public FluentHelperT withHeaders(@Nonnull Map<String,String> map)
map
- A map of HTTP header key/value pairs.@Nonnull @Beta public FluentHelperT withQueryParameter(@Nonnull String key, @Nullable String value)
Note: It is recommended to only use this function for query parameters which are not supported by the VDM by default. Using this function to bypass fluent helper method calls can lead to unsupported response handling. There is no contract on the order or priority of parameters added to the request.
Example: Use the request query option $search
to reduce the result set, leaving
only entities which match the specified search expression. This feature is supported in protocol OData v4.
new DefaultBusinessPartnerService().getAllBusinessPartner().withQueryParameter("$search", "Köln OR Cologne")
key
- Name of the query parameter.value
- Value of the query parameter.@Nonnull protected Map<String,String> getHeaders()
@Nonnull protected Map<String,String> getParametersForRequestOnly()
@Nonnull protected List<ODataRequestListener> getListeners()
Copyright © 2020 SAP SE. All rights reserved.