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

Interface NavigableEntitySingle<EntityT extends VdmEntity<EntityT>>

Type Parameters:
EntityT - The generic entity type for which request builders can be instantiated.
public interface NavigableEntitySingle<EntityT extends VdmEntity<EntityT>>
Related interface to provide access to type-safe request builders for the generic entity type.

  • Method Details

    • get

      @Nonnull GetByKeyRequestBuilder<EntityT> get()
      Fetch the current entity.
      Returns:
      A request builder to fetch multiple entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

    • update

      @Nonnull UpdateRequestBuilder<EntityT> update(@Nonnull EntityT item)
      Update an existing entity and save it to the OData service.
      Parameters:
      item - The entity object that will be updated.

      Constraints: Not nullable

      Returns:
      A request builder to update an existing entity. To perform execution, call the execute method on the request builder object.

    • delete

      @Nonnull DeleteRequestBuilder<EntityT> delete()
      Deletes the current entity in the OData service.
      Returns:
      A request builder to delete an existing entity. To perform execution, call the execute method on the request builder object.

    • applyFunction

      @Nonnull <ResultT> SingleValueFunctionRequestBuilder<ResultT> applyFunction(@Nonnull BoundFunction.SingleToSingle<EntityT,ResultT> function)
      Apply a bound function returning a single object to the current element.
      Type Parameters:
      ResultT - The return type of the function.
      Parameters:
      function - The function to apply. Functions are available on generated entity classes.
      Returns:
      A new request builder for the supplied function applied to the current element.

    • applyFunction

      @Nonnull <ResultT> CollectionValueFunctionRequestBuilder<ResultT> applyFunction(@Nonnull BoundFunction.SingleToCollection<EntityT,ResultT> function)
      Apply a bound function returning a collection of objects to the current element.
      Type Parameters:
      ResultT - The type of items in the result of the function.
      Parameters:
      function - The function to apply. Functions are available on generated entity classes.
      Returns:
      A new request builder for the supplied function applied to the current element.

    • withFunction

      @Nonnull <ResultT extends VdmEntity<ResultT>> NavigableEntitySingle<ResultT> withFunction(@Nonnull BoundFunction.SingleToSingleEntity.Composable<EntityT,ResultT> function)
      Use a composable function as a path element in an OData request. Similar to applyFunction but allows further path segments after the function. Functions must be marked as composable by the service.
      Type Parameters:
      ResultT - The return type of the function.
      Parameters:
      function - The composable functions.
      Returns:
      A request builder that allows for adding further path segments.

    • withFunction

      @Nonnull <ResultT extends VdmEntity<ResultT>> NavigableEntityCollection<ResultT> withFunction(@Nonnull BoundFunction.SingleToCollectionEntity.Composable<EntityT,ResultT> function)
      Use a composable function as a path element in an OData request. Similar to applyFunction but allows further path segments after the function. Functions must be marked as composable by the service.
      Type Parameters:
      ResultT - The return type of the function.
      Parameters:
      function - The composable functions.
      Returns:
      A request builder that allows for adding further path segments.

    • applyAction

      @Nonnull <ResultT> SingleValueActionRequestBuilder<ResultT> applyAction(@Nonnull BoundAction.SingleToSingle<EntityT,ResultT> action)
      Apply a bound action returning a single or no object to the current element.
      Type Parameters:
      ResultT - The return type of the action.
      Parameters:
      action - The action to apply. Actions are available on generated entity classes.
      Returns:
      A new request builder for the supplied action applied to the current element.

    • applyAction

      @Nonnull <ResultT> CollectionValueActionRequestBuilder<ResultT> applyAction(@Nonnull BoundAction.SingleToCollection<EntityT,ResultT> action)
      Apply a bound action returning a collection of elements to the current element.
      Type Parameters:
      ResultT - The return type of the action.
      Parameters:
      action - The action to apply. Actions are available on generated entity classes.
      Returns:
      A new request builder for the supplied action applied to the current element.