Package com.sap.cloud.sdk.datamodel.odatav4.core

Class CountRequestBuilder<EntityT extends VdmEntity<?>>

java.lang.Object
com.sap.cloud.sdk.datamodel.odatav4.core.CountRequestBuilder<EntityT>
Type Parameters:
EntityT - The generic entity type.
All Implemented Interfaces:
RequestBuilder<Long>, RequestBuilderExecutable<Long>
public class CountRequestBuilder<EntityT extends VdmEntity<?>> extends Object
Representation of an OData request as a fluent interface for further configuring the request and executing it.

  • Field Details

  • Constructor Details

    • CountRequestBuilder

      public CountRequestBuilder(@Nonnull String servicePath, @Nonnull Class<EntityT> entityClass, @Nonnull String entityCollection)
      Instantiates this request builder using the given service path to send the requests.
      Parameters:
      servicePath - The service path to direct the requests to.
      entityClass - The expected entity type.
      entityCollection - The entity collection

  • Method Details

    • toRequest

      @Nonnull public ODataRequestCount toRequest()
      Creates an instance of the ODataRequestCount based on the Entity class.

      The following settings are used:

      • the endpoint URL
      • the entity collection name
      • the filters to be applied
      Specified by:
      toRequest in interface RequestBuilder<EntityT extends VdmEntity<?>>
      Returns:
      An initialized ODataRequestCount.

    • execute

      @Nonnull public Long execute(@Nonnull Destination destination)
      Description copied from interface: RequestBuilderExecutable
      Execute the OData request.
      Specified by:
      execute in interface RequestBuilderExecutable<EntityT extends VdmEntity<?>>
      Parameters:
      destination - The destination to be used as request target.
      Returns:
      The generic OData response result.

    • filter

      @SafeVarargs @Nonnull public final CountRequestBuilder<EntityT> filter(@Nonnull FilterableBoolean<EntityT>... filters)

    • search

      @Nonnull public CountRequestBuilder<EntityT> search(@Nonnull String search)

    • search

      @Nonnull public CountRequestBuilder<EntityT> search(@Nonnull SearchExpression expression)

    • withCsrfToken

      @Nonnull public CountRequestBuilder<EntityT> withCsrfToken()
      Activates the CSRF token retrieval for this OData request. This is useful if the server does require CSRF tokens as part of the request.
      Returns:
      The same builder

    • getEntityClass

      protected Class<EntityT> getEntityClass()
      Returns a class object of the type this request builder works with.
      Returns:
      A class object of the handled type.

    • getThis

      @Nonnull protected CountRequestBuilder<EntityT> getThis()
      Get the reference to this instance.
      Returns:
      The FluentHelper instance.

    • withListener

      @Nonnull public CountRequestBuilder<EntityT> withListener(@Nonnull ODataRequestListener listener)
      An error handling class that implements the error result handler interface can be attached to this request builder. This allows custom logic to be called when an error occurs in the 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 request builder object, so calling this multiple times will replace the handler.
      Parameters:
      listener - Instance of an error handler class that implements the error result handler interface.
      Returns:
      The same request builder with its error handler set to the provided object.

    • withHeader

      @Nonnull public CountRequestBuilder<EntityT> withHeader(@Nonnull String key, @Nullable String value)
      Description copied from interface: RequestBuilder
      Gives the option to specify custom HTTP headers. Multiple headers with the same key can be specified. The returned object allows to specify the requests the headers should be used in.
      Specified by:
      withHeader in interface RequestBuilder<BuilderT extends RequestBuilder<ResultT>>
      Parameters:
      key - Name of the (first) desired HTTP header parameter.
      value - Value of the (first) desired HTTP header parameter.
      Returns:
      A request builder to specify further headers and their intended usage.

    • withHeaders

      @Nonnull public CountRequestBuilder<EntityT> withHeaders(@Nonnull Map<String,String> map)
      Description copied from interface: RequestBuilder
      Gives the option to specify a map of custom HTTP headers. The returned object allows to specify the requests the headers should be used in.
      Specified by:
      withHeaders in interface RequestBuilder<BuilderT extends RequestBuilder<ResultT>>
      Parameters:
      map - A map of HTTP header key/value pairs.
      Returns:
      A request builder to specify further headers and their intended usage.

    • withQueryParameter

      @Nonnull public CountRequestBuilder<EntityT> withQueryParameter(@Nonnull String key, @Nullable String value)
      Gives the option to specify custom query parameters for the request.

      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 request builder 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")

      Parameters:
      key - Name of the query parameter.
      value - Value of the query parameter.
      Returns:
      The same request builder.

    • getServicePath

      @Nonnull protected String getServicePath()

    • getResourcePath

      @Nonnull protected ODataResourcePath getResourcePath()

    • getHeaders

      @Nonnull protected Map<String,Collection<String>> getHeaders()
      A map containing the headers to be used only for the actual request of this FluentHelper implementation.

    • getParametersForRequestOnly

      @Nonnull protected Map<String,String> getParametersForRequestOnly()
      A map containing the custom query parameters to be used only for the actual request of this FluentHelper implementation.

    • getListeners

      @Nonnull protected List<ODataRequestListener> getListeners()