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

Class DefaultReservationDocumentService

java.lang.Object

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

All Implemented Interfaces:

OperationsOnEntityCollections, ServiceWithNavigableEntities, ReservationDocumentService

@Named("com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.DefaultReservationDocumentService")
@Deprecated
public class DefaultReservationDocumentService
extends Object
implements ServiceWithNavigableEntities, 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 inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.ReservationDocumentService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

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

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.
String	getServicePath()	Deprecated.
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.
DefaultReservationDocumentService	withServicePath(String servicePath)	Deprecated. 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

Methods inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities

applyAction, applyAction, applyFunction, applyFunction, forEntity, withFunction, withFunction

Constructor Details

DefaultReservationDocumentService

public DefaultReservationDocumentService()

Deprecated.

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

Method Details

withServicePath

@Nonnull
public DefaultReservationDocumentService withServicePath(@Nonnull
 String servicePath)

Deprecated.

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 BatchRequestBuilder batch()

Deprecated.

Description copied from interface: ReservationDocumentService

Creates a batch request builder object.

Specified by:

batch in interface ReservationDocumentService

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
public GetAllRequestBuilder<ReservationDocumentHeader_2> getAllReservationDocument()

Deprecated.

Description copied from interface: ReservationDocumentService

Fetch multiple ReservationDocumentHeader_2 entities.

Specified by:

getAllReservationDocument in interface ReservationDocumentService

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
public CountRequestBuilder<ReservationDocumentHeader_2> countReservationDocument()

Deprecated.

Description copied from interface: ReservationDocumentService

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

Specified by:

countReservationDocument in interface ReservationDocumentService

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
public GetByKeyRequestBuilder<ReservationDocumentHeader_2> getReservationDocumentByKey(String reservation)

Deprecated.

Description copied from interface: ReservationDocumentService

Fetch a single ReservationDocumentHeader_2 entity using key fields.

Specified by:

getReservationDocumentByKey in interface ReservationDocumentService

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
public CreateRequestBuilder<ReservationDocumentHeader_2> createReservationDocument(@Nonnull
 ReservationDocumentHeader_2 reservationDocumentHeader_2)

Deprecated.

Description copied from interface: ReservationDocumentService

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

Specified by:

createReservationDocument in interface ReservationDocumentService

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
public UpdateRequestBuilder<ReservationDocumentHeader_2> updateReservationDocument(@Nonnull
 ReservationDocumentHeader_2 reservationDocumentHeader_2)

Deprecated.

Description copied from interface: ReservationDocumentService

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

Specified by:

updateReservationDocument in interface ReservationDocumentService

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
public DeleteRequestBuilder<ReservationDocumentHeader_2> deleteReservationDocument(@Nonnull
 ReservationDocumentHeader_2 reservationDocumentHeader_2)

Deprecated.

Description copied from interface: ReservationDocumentService

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

Specified by:

deleteReservationDocument in interface ReservationDocumentService

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
public GetAllRequestBuilder<ReservationDocumentItem_2> getAllReservationDocumentItem()

Deprecated.

Description copied from interface: ReservationDocumentService

Fetch multiple ReservationDocumentItem_2 entities.

Specified by:

getAllReservationDocumentItem in interface ReservationDocumentService

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
public CountRequestBuilder<ReservationDocumentItem_2> countReservationDocumentItem()

Deprecated.

Description copied from interface: ReservationDocumentService

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

Specified by:

countReservationDocumentItem in interface ReservationDocumentService

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

Deprecated.

Description copied from interface: ReservationDocumentService

Fetch a single ReservationDocumentItem_2 entity using key fields.

Specified by:

getReservationDocumentItemByKey in interface ReservationDocumentService

Parameters:

reservation - Number of reservation/dependent requirements

Constraints: Not nullable, Maximum length: 10

reservationItem - Item Number of Reservation / Dependent Requirements

Constraints: Not nullable, Maximum length: 4

recordType - Record type

Constraints: Not nullable, Maximum length: 1

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
public UpdateRequestBuilder<ReservationDocumentItem_2> updateReservationDocumentItem(@Nonnull
 ReservationDocumentItem_2 reservationDocumentItem_2)

Deprecated.

Description copied from interface: ReservationDocumentService

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

Specified by:

updateReservationDocumentItem in interface ReservationDocumentService

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.

getServicePath

@Nonnull
public String getServicePath()

Deprecated.

Specified by:

getServicePath in interface ServiceWithNavigableEntities