Package com.sap.cloud.sdk.s4hana.datamodel.odatav4.services

Interface ReservationDocumentService

All Known Implementing Classes:

DefaultReservationDocumentService

@Deprecated
public interface ReservationDocumentService

Deprecated.

The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

This service contains the header and item nodes for reservation documents. You can create a reservation for a material with some quantity and assign that reserved material to a cost center, sales order, or asset. A reservation can also be created for a transfer posting from one plant to another. For an existing reservation, you can change the updatable fields of the items. The service also allows you to delete existing reservation documents. It can be consumed by external systems and user interfaces..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service:	CE_APIRESERVATIONDOCUMENT_0001
API Version:	1.0.1
Minimum ERP Version:	2302
Communication Scenario:	Reservation Integration(SAP_COM_0112)
Scope Items:	Core Inventory Management(BMC), Core Inventory Management(OMC)
Authentication Methods:	x509
Service Group Name:	API_RESERVATION_DOCUMENT
Business Object:	Reservation Document

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SERVICE_PATH	Deprecated. If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method	Description
BatchRequestBuilder	batch()	Deprecated. Creates a batch request builder object.
CountRequestBuilder<ReservationDocumentHeader_2>	countReservationDocument()	Deprecated. Fetch the number of entries from the ReservationDocumentHeader_2 entity collection matching the filter and search expressions.
CountRequestBuilder<ReservationDocumentItem_2>	countReservationDocumentItem()	Deprecated. Fetch the number of entries from the ReservationDocumentItem_2 entity collection matching the filter and search expressions.
CreateRequestBuilder<ReservationDocumentHeader_2>	createReservationDocument(ReservationDocumentHeader_2 reservationDocumentHeader_2)	Deprecated. Create a new ReservationDocumentHeader_2 entity and save it to the S/4HANA system.
DeleteRequestBuilder<ReservationDocumentHeader_2>	deleteReservationDocument(ReservationDocumentHeader_2 reservationDocumentHeader_2)	Deprecated. Deletes an existing ReservationDocumentHeader_2 entity in the S/4HANA system.
GetAllRequestBuilder<ReservationDocumentHeader_2>	getAllReservationDocument()	Deprecated. Fetch multiple ReservationDocumentHeader_2 entities.
GetAllRequestBuilder<ReservationDocumentItem_2>	getAllReservationDocumentItem()	Deprecated. Fetch multiple ReservationDocumentItem_2 entities.
GetByKeyRequestBuilder<ReservationDocumentHeader_2>	getReservationDocumentByKey(String reservation)	Deprecated. Fetch a single ReservationDocumentHeader_2 entity using key fields.
GetByKeyRequestBuilder<ReservationDocumentItem_2>	getReservationDocumentItemByKey(String reservation, String reservationItem, String recordType)	Deprecated. Fetch a single ReservationDocumentItem_2 entity using key fields.
UpdateRequestBuilder<ReservationDocumentHeader_2>	updateReservationDocument(ReservationDocumentHeader_2 reservationDocumentHeader_2)	Deprecated. Update an existing ReservationDocumentHeader_2 entity and save it to the S/4HANA system.
UpdateRequestBuilder<ReservationDocumentItem_2>	updateReservationDocumentItem(ReservationDocumentItem_2 reservationDocumentItem_2)	Deprecated. Update an existing ReservationDocumentItem_2 entity and save it to the S/4HANA system.
ReservationDocumentService	withServicePath(String servicePath)	Deprecated. Overrides the default service path and returns a new service instance with the specified service path.

Field Details

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

Deprecated.

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

• Constant Field Values

Method Details

withServicePath

@Nonnull
ReservationDocumentService withServicePath(@Nonnull
 String servicePath)

Deprecated.

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
BatchRequestBuilder batch()

Deprecated.

Creates a batch request builder object.

Returns:

A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.

getAllReservationDocument

@Nonnull
GetAllRequestBuilder<ReservationDocumentHeader_2> getAllReservationDocument()

Deprecated.

Fetch multiple ReservationDocumentHeader_2 entities.

Returns:

A request builder to fetch multiple ReservationDocumentHeader_2 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.

countReservationDocument

@Nonnull
CountRequestBuilder<ReservationDocumentHeader_2> countReservationDocument()

Deprecated.

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

Returns:

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

getReservationDocumentByKey

@Nonnull
GetByKeyRequestBuilder<ReservationDocumentHeader_2> getReservationDocumentByKey(String reservation)

Deprecated.

Fetch a single ReservationDocumentHeader_2 entity using key fields.

Parameters:

reservation - Number of reservation/dependent requirements

Constraints: Not nullable, Maximum length: 10

Returns:

A request builder to fetch a single ReservationDocumentHeader_2 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.

createReservationDocument

@Nonnull
CreateRequestBuilder<ReservationDocumentHeader_2> createReservationDocument(@Nonnull
 ReservationDocumentHeader_2 reservationDocumentHeader_2)

Deprecated.

Create a new ReservationDocumentHeader_2 entity and save it to the S/4HANA system.

Parameters:

reservationDocumentHeader_2 - ReservationDocumentHeader_2 entity object that will be created in the S/4HANA system.

Returns:

A request builder to create a new ReservationDocumentHeader_2 entity. To perform execution, call the execute method on the request builder object.

updateReservationDocument

@Nonnull
UpdateRequestBuilder<ReservationDocumentHeader_2> updateReservationDocument(@Nonnull
 ReservationDocumentHeader_2 reservationDocumentHeader_2)

Deprecated.

Update an existing ReservationDocumentHeader_2 entity and save it to the S/4HANA system.

Parameters:

reservationDocumentHeader_2 - ReservationDocumentHeader_2 entity object that will be updated in the S/4HANA system.

Returns:

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

deleteReservationDocument

@Nonnull
DeleteRequestBuilder<ReservationDocumentHeader_2> deleteReservationDocument(@Nonnull
 ReservationDocumentHeader_2 reservationDocumentHeader_2)

Deprecated.

Deletes an existing ReservationDocumentHeader_2 entity in the S/4HANA system.

Parameters:

reservationDocumentHeader_2 - ReservationDocumentHeader_2 entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllReservationDocumentItem

@Nonnull
GetAllRequestBuilder<ReservationDocumentItem_2> getAllReservationDocumentItem()

Deprecated.

Fetch multiple ReservationDocumentItem_2 entities.

Returns:

A request builder to fetch multiple ReservationDocumentItem_2 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.

countReservationDocumentItem

@Nonnull
CountRequestBuilder<ReservationDocumentItem_2> countReservationDocumentItem()

Deprecated.

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

Returns:

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

getReservationDocumentItemByKey

@Nonnull
GetByKeyRequestBuilder<ReservationDocumentItem_2> getReservationDocumentItemByKey(String reservation,
 String reservationItem,
 String recordType)

Deprecated.

Fetch a single ReservationDocumentItem_2 entity using key fields.

Parameters:

reservationItem - Item Number of Reservation / Dependent Requirements

Constraints: Not nullable, Maximum length: 4

recordType - Record type

Constraints: Not nullable, Maximum length: 1

reservation - Number of reservation/dependent requirements

Constraints: Not nullable, Maximum length: 10

Returns:

A request builder to fetch a single ReservationDocumentItem_2 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.

updateReservationDocumentItem

@Nonnull
UpdateRequestBuilder<ReservationDocumentItem_2> updateReservationDocumentItem(@Nonnull
 ReservationDocumentItem_2 reservationDocumentItem_2)

Deprecated.

Update an existing ReservationDocumentItem_2 entity and save it to the S/4HANA system.

Parameters:

reservationDocumentItem_2 - ReservationDocumentItem_2 entity object that will be updated in the S/4HANA system.

Returns:

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