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

Interface ServiceWithNavigableEntityCollection<EntityT extends VdmEntity<EntityT>>

Type Parameters:

EntityT - The generic entity type for which request builders can be instantiated.

@Beta
public interface ServiceWithNavigableEntityCollection<EntityT extends VdmEntity<EntityT>>

Related interface to provide access to type-safe request builders for the generic entity type.

Method Summary

Modifier and Type	Method and Description
CountRequestBuilder<EntityT>	count() Fetch the number of entries from the entity collection matching the filter and search expressions.
CreateRequestBuilder<EntityT>	create(EntityT item) Create a new entity and save it to the OData service.
DeleteRequestBuilder<EntityT>	delete(EntityT item) Deletes an existing entity in the OData service.
ServiceWithNavigableEntities.NavigableEntity<EntityT>	forEntity(EntityT item) Navigate to a specific entity of current property.
GetAllRequestBuilder<EntityT>	getAll() Fetch multiple entities.
GetByKeyRequestBuilder<EntityT>	getByKey(EntityT item) Fetch a single entity using the key fields of provided template entity.
UpdateRequestBuilder<EntityT>	update(EntityT item) Update an existing entity and save it to the OData service.

Method Detail

forEntity

@Nonnull
ServiceWithNavigableEntities.NavigableEntity<EntityT> forEntity(@Nonnull
                                                                         EntityT item)

Navigate to a specific entity of current property.

Parameters:

item - A template entity instance that contains all necessary key attributes.

Constraints: Not nullable

Returns:

A request builder to navigate the service request using the provided key fields of an entity. With another navigation property this object can be used to instantiate new request builders.

getAll

@Nonnull
GetAllRequestBuilder<EntityT> getAll()

Fetch multiple entities.

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.

getByKey

@Nonnull
GetByKeyRequestBuilder<EntityT> getByKey(@Nonnull
                                                  EntityT item)

Fetch a single entity using the key fields of provided template entity.

Parameters:

item - A template entity instance that contains all necessary key attributes.

Constraints: Not nullable

Returns:

A request builder to fetch a single entity using key fields. 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.

create

@Nonnull
CreateRequestBuilder<EntityT> create(@Nonnull
                                              EntityT item)

Create a new entity and save it to the OData service.

Parameters:

item - The entity object that will be created and saved.

Constraints: Not nullable

Returns:

A request builder to create and save a new entity. 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(@Nonnull
                                              EntityT item)

Deletes an existing entity in the OData service.

Parameters:

item - The entity object that will be deleted.

Constraints: Not nullable

Returns:

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

count

@Nonnull
CountRequestBuilder<EntityT> count()

Fetch the number of entries from the entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of 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.