com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface ReservationDocumentService

All Superinterfaces:

BatchService<ReservationDocumentServiceBatch>

All Known Implementing Classes:

DefaultReservationDocumentService

public interface ReservationDocumentService
extends BatchService<ReservationDocumentServiceBatch>

This service enables you to retrieve, create and delete reservation documents. For example, a user might create a reservation for a material with some quantity and assign that reserved material to a cost center, a sales order or an asset. A reservation can also be created for a transfer posting from one plant to another. The service also allows to delete existing reservation documents. It can be consumed by external systems and user interfaces.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_RESERVATION_DOCUMENT_SRV
API Version:	1
Communication Scenario:	Reservation Integration (SAP_COM_0112)
Scope Items:	Core Inventory Management (BMC)
Authentication Methods:	Basic, x509

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH 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 and Description
ReservationDocumentHeaderFluentHelper	getAllReservationDocumentHeader() Fetch multiple ReservationDocumentHeader entities.
ReservationDocumentItemFluentHelper	getAllReservationDocumentItem() Fetch multiple ReservationDocumentItem entities.
ReservationDocumentHeaderByKeyFluentHelper	getReservationDocumentHeaderByKey(String reservation) Fetch a single ReservationDocumentHeader entity using key fields.
ReservationDocumentItemByKeyFluentHelper	getReservationDocumentItemByKey(String reservation, String reservationItem, String recordType) Fetch a single ReservationDocumentItem entity using key fields.
ReservationDocumentService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

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 Detail

withServicePath

@Nonnull
ReservationDocumentService withServicePath(@Nonnull
                                                    String servicePath)

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.

getAllReservationDocumentHeader

@Nonnull
ReservationDocumentHeaderFluentHelper getAllReservationDocumentHeader()

Fetch multiple ReservationDocumentHeader entities.

Returns:

A fluent helper to fetch multiple ReservationDocumentHeader entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getReservationDocumentHeaderByKey

@Nonnull
ReservationDocumentHeaderByKeyFluentHelper getReservationDocumentHeaderByKey(String reservation)

Fetch a single ReservationDocumentHeader entity using key fields.

Parameters:

reservation - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single ReservationDocumentHeader entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getAllReservationDocumentItem

@Nonnull
ReservationDocumentItemFluentHelper getAllReservationDocumentItem()

Fetch multiple ReservationDocumentItem entities.

Returns:

A fluent helper to fetch multiple ReservationDocumentItem entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getReservationDocumentItemByKey

@Nonnull
ReservationDocumentItemByKeyFluentHelper getReservationDocumentItemByKey(String reservation,
                                                                                  String reservationItem,
                                                                                  String recordType)

Fetch a single ReservationDocumentItem entity using key fields.

Parameters:

reservationItem - Specifies the number that uniquely identifies an item in .

Constraints: Not nullable, Maximum length: 4

recordType - Record type

Constraints: Not nullable, Maximum length: 1

reservation - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single ReservationDocumentItem entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.