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

Class DefaultCustomerReturnsDeliveryService

java.lang.Object

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

All Implemented Interfaces:

CustomerReturnsDeliveryService

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

This service enables you to read, create, update, and delete customer returns deliveries in an API call. It can be consumed in Fiori apps and on other user interfaces.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CUSTOMER_RETURNS_DELIVERY_SRV
API Version:	2
Communication Scenario:	Delivery Processing Integration (SAP_COM_0106)
Scope Items:	Delivery Processing without Order Reference (1MI), Sell from Stock (BD9), Free of Charge Delivery (BDA), Accelerated Customer Returns (BKP), Procurement of Direct Materials (J45)
Authentication Methods:	Basic, x509
Business Object:	CustomerReturnsDelivery

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.CustomerReturnsDeliveryService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultCustomerReturnsDeliveryService() Creates a service using CustomerReturnsDeliveryService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
ConfirmPutawayAllItemsFluentHelper	confirmPutawayAllItems(String deliveryDocument) Creates a fluent helper for the ConfirmPutawayAllItems OData function import.
ConfirmPutawayOneItemFluentHelper	confirmPutawayOneItem(String deliveryDocument, String deliveryDocumentItem) Creates a fluent helper for the ConfirmPutawayOneItem OData function import.
ReturnsDeliveryHeaderCreateFluentHelper	createReturnsDeliveryHeader(ReturnsDeliveryHeader returnsDeliveryHeader) Create a new ReturnsDeliveryHeader entity and save it to the S/4HANA system.
ReturnsDeliveryHeaderDeleteFluentHelper	deleteReturnsDeliveryHeader(ReturnsDeliveryHeader returnsDeliveryHeader) Deletes an existing ReturnsDeliveryHeader entity in the S/4HANA system.
ReturnsDeliveryItemDeleteFluentHelper	deleteReturnsDeliveryItem(ReturnsDeliveryItem returnsDeliveryItem) Deletes an existing ReturnsDeliveryItem entity in the S/4HANA system.
ReturnsDeliveryHeaderFluentHelper	getAllReturnsDeliveryHeader() Fetch multiple ReturnsDeliveryHeader entities.
ReturnsDeliveryItemFluentHelper	getAllReturnsDeliveryItem() Fetch multiple ReturnsDeliveryItem entities.
ReturnsDeliveryDocFlowByKeyFluentHelper	getReturnsDeliveryDocFlowByKey(String precedingDocument, String precedingDocumentItem, String subsequentDocumentCategory) Fetch a single ReturnsDeliveryDocFlow entity using key fields.
ReturnsDeliveryHeaderByKeyFluentHelper	getReturnsDeliveryHeaderByKey(String deliveryDocument) Fetch a single ReturnsDeliveryHeader entity using key fields.
ReturnsDeliveryItemByKeyFluentHelper	getReturnsDeliveryItemByKey(String deliveryDocument, String deliveryDocumentItem) Fetch a single ReturnsDeliveryItem entity using key fields.
PostGoodsReceiptFluentHelper	postGoodsReceipt(String deliveryDocument) Creates a fluent helper for the PostGoodsReceipt OData function import.
PutawayAllItemsFluentHelper	putawayAllItems(String deliveryDocument) Creates a fluent helper for the PutawayAllItems OData function import.
PutawayOneItemFluentHelper	putawayOneItem(String deliveryDocument, String deliveryDocumentItem) Creates a fluent helper for the PutawayOneItem OData function import.
ReverseGoodsReceiptFluentHelper	reverseGoodsReceipt(LocalDateTime actualGoodsMovementDate, String deliveryDocument) Creates a fluent helper for the ReverseGoodsReceipt OData function import.
ReturnsDeliveryDocFlowUpdateFluentHelper	updateReturnsDeliveryDocFlow(ReturnsDeliveryDocFlow returnsDeliveryDocFlow) Update an existing ReturnsDeliveryDocFlow entity and save it to the S/4HANA system.
ReturnsDeliveryHeaderUpdateFluentHelper	updateReturnsDeliveryHeader(ReturnsDeliveryHeader returnsDeliveryHeader) Update an existing ReturnsDeliveryHeader entity and save it to the S/4HANA system.
ReturnsDeliveryItemUpdateFluentHelper	updateReturnsDeliveryItem(ReturnsDeliveryItem returnsDeliveryItem) Update an existing ReturnsDeliveryItem entity and save it to the S/4HANA system.
DefaultCustomerReturnsDeliveryService	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

DefaultCustomerReturnsDeliveryService

public DefaultCustomerReturnsDeliveryService()

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

Method Detail

withServicePath

@Nonnull
public DefaultCustomerReturnsDeliveryService withServicePath(@Nonnull
                                                                      String servicePath)

Description copied from interface: CustomerReturnsDeliveryService

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 CustomerReturnsDeliveryService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path

getReturnsDeliveryDocFlowByKey

@Nonnull
public ReturnsDeliveryDocFlowByKeyFluentHelper getReturnsDeliveryDocFlowByKey(String precedingDocument,
                                                                                       String precedingDocumentItem,
                                                                                       String subsequentDocumentCategory)

Description copied from interface: CustomerReturnsDeliveryService

Fetch a single ReturnsDeliveryDocFlow entity using key fields.

Specified by:

getReturnsDeliveryDocFlowByKey in interface CustomerReturnsDeliveryService

Parameters:

precedingDocument - Number that uniquely identifies the preceding sales, delivery, or billing document (for example, the quotation from which you created a sales order).

Constraints: Not nullable, Maximum length: 10

precedingDocumentItem - Preceding Item of an SD Document

Constraints: Not nullable, Maximum length: 6

subsequentDocumentCategory - The document category of the sales document that you have created from a preceding document (for example, a delivery note that has been created from a sales order).

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single ReturnsDeliveryDocFlow 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.

updateReturnsDeliveryDocFlow

@Nonnull
public ReturnsDeliveryDocFlowUpdateFluentHelper updateReturnsDeliveryDocFlow(@Nonnull
                                                                                      ReturnsDeliveryDocFlow returnsDeliveryDocFlow)

Description copied from interface: CustomerReturnsDeliveryService

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

Specified by:

updateReturnsDeliveryDocFlow in interface CustomerReturnsDeliveryService

Parameters:

returnsDeliveryDocFlow - ReturnsDeliveryDocFlow entity object that will be updated in the S/4HANA system.

Returns:

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

getAllReturnsDeliveryHeader

@Nonnull
public ReturnsDeliveryHeaderFluentHelper getAllReturnsDeliveryHeader()

Description copied from interface: CustomerReturnsDeliveryService

Fetch multiple ReturnsDeliveryHeader entities.

Specified by:

getAllReturnsDeliveryHeader in interface CustomerReturnsDeliveryService

Returns:

A fluent helper to fetch multiple ReturnsDeliveryHeader 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.

getReturnsDeliveryHeaderByKey

@Nonnull
public ReturnsDeliveryHeaderByKeyFluentHelper getReturnsDeliveryHeaderByKey(String deliveryDocument)

Description copied from interface: CustomerReturnsDeliveryService

Fetch a single ReturnsDeliveryHeader entity using key fields.

Specified by:

getReturnsDeliveryHeaderByKey in interface CustomerReturnsDeliveryService

Parameters:

deliveryDocument - The number that uniquely identifies the delivery.

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single ReturnsDeliveryHeader 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.

createReturnsDeliveryHeader

@Nonnull
public ReturnsDeliveryHeaderCreateFluentHelper createReturnsDeliveryHeader(@Nonnull
                                                                                    ReturnsDeliveryHeader returnsDeliveryHeader)

Description copied from interface: CustomerReturnsDeliveryService

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

Specified by:

createReturnsDeliveryHeader in interface CustomerReturnsDeliveryService

Parameters:

returnsDeliveryHeader - ReturnsDeliveryHeader entity object that will be created in the S/4HANA system.

Returns:

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

updateReturnsDeliveryHeader

@Nonnull
public ReturnsDeliveryHeaderUpdateFluentHelper updateReturnsDeliveryHeader(@Nonnull
                                                                                    ReturnsDeliveryHeader returnsDeliveryHeader)

Description copied from interface: CustomerReturnsDeliveryService

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

Specified by:

updateReturnsDeliveryHeader in interface CustomerReturnsDeliveryService

Parameters:

returnsDeliveryHeader - ReturnsDeliveryHeader entity object that will be updated in the S/4HANA system.

Returns:

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

deleteReturnsDeliveryHeader

@Nonnull
public ReturnsDeliveryHeaderDeleteFluentHelper deleteReturnsDeliveryHeader(@Nonnull
                                                                                    ReturnsDeliveryHeader returnsDeliveryHeader)

Description copied from interface: CustomerReturnsDeliveryService

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

Specified by:

deleteReturnsDeliveryHeader in interface CustomerReturnsDeliveryService

Parameters:

returnsDeliveryHeader - ReturnsDeliveryHeader entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllReturnsDeliveryItem

@Nonnull
public ReturnsDeliveryItemFluentHelper getAllReturnsDeliveryItem()

Description copied from interface: CustomerReturnsDeliveryService

Fetch multiple ReturnsDeliveryItem entities.

Specified by:

getAllReturnsDeliveryItem in interface CustomerReturnsDeliveryService

Returns:

A fluent helper to fetch multiple ReturnsDeliveryItem 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.

getReturnsDeliveryItemByKey

@Nonnull
public ReturnsDeliveryItemByKeyFluentHelper getReturnsDeliveryItemByKey(String deliveryDocument,
                                                                                 String deliveryDocumentItem)

Description copied from interface: CustomerReturnsDeliveryService

Fetch a single ReturnsDeliveryItem entity using key fields.

Specified by:

getReturnsDeliveryItemByKey in interface CustomerReturnsDeliveryService

Parameters:

deliveryDocument - The number that uniquely identifies the delivery.

Constraints: Not nullable, Maximum length: 10

deliveryDocumentItem - The number that uniquely identifies the item in a delivery.

Constraints: Not nullable, Maximum length: 6

Returns:

A fluent helper to fetch a single ReturnsDeliveryItem 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.

updateReturnsDeliveryItem

@Nonnull
public ReturnsDeliveryItemUpdateFluentHelper updateReturnsDeliveryItem(@Nonnull
                                                                                ReturnsDeliveryItem returnsDeliveryItem)

Description copied from interface: CustomerReturnsDeliveryService

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

Specified by:

updateReturnsDeliveryItem in interface CustomerReturnsDeliveryService

Parameters:

returnsDeliveryItem - ReturnsDeliveryItem entity object that will be updated in the S/4HANA system.

Returns:

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

deleteReturnsDeliveryItem

@Nonnull
public ReturnsDeliveryItemDeleteFluentHelper deleteReturnsDeliveryItem(@Nonnull
                                                                                ReturnsDeliveryItem returnsDeliveryItem)

Description copied from interface: CustomerReturnsDeliveryService

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

Specified by:

deleteReturnsDeliveryItem in interface CustomerReturnsDeliveryService

Parameters:

returnsDeliveryItem - ReturnsDeliveryItem entity object that will be deleted in the S/4HANA system.

Returns:

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

reverseGoodsReceipt

@Nonnull
public ReverseGoodsReceiptFluentHelper reverseGoodsReceipt(LocalDateTime actualGoodsMovementDate,
                                                                    String deliveryDocument)

Description copied from interface: CustomerReturnsDeliveryService

Creates a fluent helper for the ReverseGoodsReceipt OData function import.

Specified by:

reverseGoodsReceipt in interface CustomerReturnsDeliveryService

Parameters:

actualGoodsMovementDate - Actual GI Date

Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: ActualGoodsMovementDate

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

Returns:

A fluent helper object that will execute the ReverseGoodsReceipt OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

postGoodsReceipt

@Nonnull
public PostGoodsReceiptFluentHelper postGoodsReceipt(String deliveryDocument)

Description copied from interface: CustomerReturnsDeliveryService

Creates a fluent helper for the PostGoodsReceipt OData function import.

Specified by:

postGoodsReceipt in interface CustomerReturnsDeliveryService

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

Returns:

A fluent helper object that will execute the PostGoodsReceipt OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

confirmPutawayAllItems

@Nonnull
public ConfirmPutawayAllItemsFluentHelper confirmPutawayAllItems(String deliveryDocument)

Description copied from interface: CustomerReturnsDeliveryService

Creates a fluent helper for the ConfirmPutawayAllItems OData function import.

Specified by:

confirmPutawayAllItems in interface CustomerReturnsDeliveryService

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

Returns:

A fluent helper object that will execute the ConfirmPutawayAllItems OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

confirmPutawayOneItem

@Nonnull
public ConfirmPutawayOneItemFluentHelper confirmPutawayOneItem(String deliveryDocument,
                                                                        String deliveryDocumentItem)

Description copied from interface: CustomerReturnsDeliveryService

Creates a fluent helper for the ConfirmPutawayOneItem OData function import.

Specified by:

confirmPutawayOneItem in interface CustomerReturnsDeliveryService

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

deliveryDocumentItem - Item

Constraints: Not nullable, Maximum length: 6

Original parameter name from the Odata EDM: DeliveryDocumentItem

Returns:

A fluent helper object that will execute the ConfirmPutawayOneItem OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

putawayAllItems

@Nonnull
public PutawayAllItemsFluentHelper putawayAllItems(String deliveryDocument)

Description copied from interface: CustomerReturnsDeliveryService

Creates a fluent helper for the PutawayAllItems OData function import.

Specified by:

putawayAllItems in interface CustomerReturnsDeliveryService

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

Returns:

A fluent helper object that will execute the PutawayAllItems OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

putawayOneItem

@Nonnull
public PutawayOneItemFluentHelper putawayOneItem(String deliveryDocument,
                                                          String deliveryDocumentItem)

Description copied from interface: CustomerReturnsDeliveryService

Creates a fluent helper for the PutawayOneItem OData function import.

Specified by:

putawayOneItem in interface CustomerReturnsDeliveryService

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

deliveryDocumentItem - Item

Constraints: Not nullable, Maximum length: 6

Original parameter name from the Odata EDM: DeliveryDocumentItem

Returns:

A fluent helper object that will execute the PutawayOneItem OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.