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

Class DefaultReservationDocumentService

java.lang.Object

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

All Implemented Interfaces:

BatchService<ReservationDocumentServiceBatch>, ReservationDocumentService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultReservationDocumentService")
public class DefaultReservationDocumentService
extends Object
implements ReservationDocumentService

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 inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.ReservationDocumentService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultReservationDocumentService() Creates a service using ReservationDocumentService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultReservationDocumentServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
ReservationDocumentHeaderCreateFluentHelper	createReservationDocumentHeader(ReservationDocumentHeader reservationDocumentHeader) Create a new ReservationDocumentHeader entity and save it to the S/4HANA system.
ReservationDocumentHeaderDeleteFluentHelper	deleteReservationDocumentHeader(ReservationDocumentHeader reservationDocumentHeader) Deletes an existing ReservationDocumentHeader entity in the S/4HANA system.
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.
DefaultReservationDocumentService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultReservationDocumentService

public DefaultReservationDocumentService()

Creates a service using ReservationDocumentService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultReservationDocumentService withServicePath(@Nonnull
                                                                  String servicePath)

Description copied from interface: ReservationDocumentService

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

Specified by:

withServicePath in interface ReservationDocumentService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultReservationDocumentServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<ReservationDocumentServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllReservationDocumentHeader

@Nonnull
public ReservationDocumentHeaderFluentHelper getAllReservationDocumentHeader()

Description copied from interface: ReservationDocumentService

Fetch multiple ReservationDocumentHeader entities.

Specified by:

getAllReservationDocumentHeader in interface ReservationDocumentService

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
public ReservationDocumentHeaderByKeyFluentHelper getReservationDocumentHeaderByKey(String reservation)

Description copied from interface: ReservationDocumentService

Fetch a single ReservationDocumentHeader entity using key fields.

Specified by:

getReservationDocumentHeaderByKey in interface ReservationDocumentService

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.

createReservationDocumentHeader

@Nonnull
public ReservationDocumentHeaderCreateFluentHelper createReservationDocumentHeader(@Nonnull
                                                                                            ReservationDocumentHeader reservationDocumentHeader)

Description copied from interface: ReservationDocumentService

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

Specified by:

createReservationDocumentHeader in interface ReservationDocumentService

Parameters:

reservationDocumentHeader - ReservationDocumentHeader entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ReservationDocumentHeader entity. To perform execution, call the execute method on the fluent helper object.

deleteReservationDocumentHeader

@Nonnull
public ReservationDocumentHeaderDeleteFluentHelper deleteReservationDocumentHeader(@Nonnull
                                                                                            ReservationDocumentHeader reservationDocumentHeader)

Description copied from interface: ReservationDocumentService

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

Specified by:

deleteReservationDocumentHeader in interface ReservationDocumentService

Parameters:

reservationDocumentHeader - ReservationDocumentHeader entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing ReservationDocumentHeader entity. To perform execution, call the execute method on the fluent helper object.

getAllReservationDocumentItem

@Nonnull
public ReservationDocumentItemFluentHelper getAllReservationDocumentItem()

Description copied from interface: ReservationDocumentService

Fetch multiple ReservationDocumentItem entities.

Specified by:

getAllReservationDocumentItem in interface ReservationDocumentService

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
public ReservationDocumentItemByKeyFluentHelper getReservationDocumentItemByKey(String reservation,
                                                                                         String reservationItem,
                                                                                         String recordType)

Description copied from interface: ReservationDocumentService

Fetch a single ReservationDocumentItem entity using key fields.

Specified by:

getReservationDocumentItemByKey in interface ReservationDocumentService

Parameters:

reservation - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

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

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.