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

Class DefaultInboundDeliveryService

java.lang.Object

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

All Implemented Interfaces:

InboundDeliveryService

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

This service enables you to read, create, update, and delete inbound 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_INBOUND_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:	InboundDelivery

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultInboundDeliveryService() Creates a service using InboundDeliveryService.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.
InbDeliveryHeaderCreateFluentHelper	createInbDeliveryHeader(InbDeliveryHeader inbDeliveryHeader) Create a new InbDeliveryHeader entity and save it to the S/4HANA system.
InbDeliveryHeaderDeleteFluentHelper	deleteInbDeliveryHeader(InbDeliveryHeader inbDeliveryHeader) Deletes an existing InbDeliveryHeader entity in the S/4HANA system.
InbDeliveryItemDeleteFluentHelper	deleteInbDeliveryItem(InbDeliveryItem inbDeliveryItem) Deletes an existing InbDeliveryItem entity in the S/4HANA system.
InbDeliveryHeaderFluentHelper	getAllInbDeliveryHeader() Fetch multiple InbDeliveryHeader entities.
InbDeliveryItemFluentHelper	getAllInbDeliveryItem() Fetch multiple InbDeliveryItem entities.
InbDeliveryDocFlowByKeyFluentHelper	getInbDeliveryDocFlowByKey(String precedingDocument, String precedingDocumentItem, String subsequentDocumentCategory) Fetch a single InbDeliveryDocFlow entity using key fields.
InbDeliveryHeaderByKeyFluentHelper	getInbDeliveryHeaderByKey(String deliveryDocument) Fetch a single InbDeliveryHeader entity using key fields.
InbDeliveryItemByKeyFluentHelper	getInbDeliveryItemByKey(String deliveryDocument, String deliveryDocumentItem) Fetch a single InbDeliveryItem 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(String deliveryDocument, LocalDateTime actualGoodsMovementDate) Creates a fluent helper for the ReverseGoodsReceipt OData function import.
InbDeliveryDocFlowUpdateFluentHelper	updateInbDeliveryDocFlow(InbDeliveryDocFlow inbDeliveryDocFlow) Update an existing InbDeliveryDocFlow entity and save it to the S/4HANA system.
InbDeliveryHeaderUpdateFluentHelper	updateInbDeliveryHeader(InbDeliveryHeader inbDeliveryHeader) Update an existing InbDeliveryHeader entity and save it to the S/4HANA system.
InbDeliveryItemUpdateFluentHelper	updateInbDeliveryItem(InbDeliveryItem inbDeliveryItem) Update an existing InbDeliveryItem entity and save it to the S/4HANA system.
DefaultInboundDeliveryService	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

DefaultInboundDeliveryService

public DefaultInboundDeliveryService()

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

Method Detail

withServicePath

@Nonnull
public DefaultInboundDeliveryService withServicePath(@Nonnull
                                                              String servicePath)

Description copied from interface: InboundDeliveryService

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 InboundDeliveryService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path

getInbDeliveryDocFlowByKey

@Nonnull
public InbDeliveryDocFlowByKeyFluentHelper getInbDeliveryDocFlowByKey(String precedingDocument,
                                                                               String precedingDocumentItem,
                                                                               String subsequentDocumentCategory)

Description copied from interface: InboundDeliveryService

Fetch a single InbDeliveryDocFlow entity using key fields.

Specified by:

getInbDeliveryDocFlowByKey in interface InboundDeliveryService

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 InbDeliveryDocFlow 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.

updateInbDeliveryDocFlow

@Nonnull
public InbDeliveryDocFlowUpdateFluentHelper updateInbDeliveryDocFlow(@Nonnull
                                                                              InbDeliveryDocFlow inbDeliveryDocFlow)

Description copied from interface: InboundDeliveryService

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

Specified by:

updateInbDeliveryDocFlow in interface InboundDeliveryService

Parameters:

inbDeliveryDocFlow - InbDeliveryDocFlow entity object that will be updated in the S/4HANA system.

Returns:

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

getAllInbDeliveryHeader

@Nonnull
public InbDeliveryHeaderFluentHelper getAllInbDeliveryHeader()

Description copied from interface: InboundDeliveryService

Fetch multiple InbDeliveryHeader entities.

Specified by:

getAllInbDeliveryHeader in interface InboundDeliveryService

Returns:

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

getInbDeliveryHeaderByKey

@Nonnull
public InbDeliveryHeaderByKeyFluentHelper getInbDeliveryHeaderByKey(String deliveryDocument)

Description copied from interface: InboundDeliveryService

Fetch a single InbDeliveryHeader entity using key fields.

Specified by:

getInbDeliveryHeaderByKey in interface InboundDeliveryService

Parameters:

deliveryDocument - The number that uniquely identifies the delivery.

Constraints: Not nullable, Maximum length: 10

Returns:

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

createInbDeliveryHeader

@Nonnull
public InbDeliveryHeaderCreateFluentHelper createInbDeliveryHeader(@Nonnull
                                                                            InbDeliveryHeader inbDeliveryHeader)

Description copied from interface: InboundDeliveryService

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

Specified by:

createInbDeliveryHeader in interface InboundDeliveryService

Parameters:

inbDeliveryHeader - InbDeliveryHeader entity object that will be created in the S/4HANA system.

Returns:

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

updateInbDeliveryHeader

@Nonnull
public InbDeliveryHeaderUpdateFluentHelper updateInbDeliveryHeader(@Nonnull
                                                                            InbDeliveryHeader inbDeliveryHeader)

Description copied from interface: InboundDeliveryService

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

Specified by:

updateInbDeliveryHeader in interface InboundDeliveryService

Parameters:

inbDeliveryHeader - InbDeliveryHeader entity object that will be updated in the S/4HANA system.

Returns:

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

deleteInbDeliveryHeader

@Nonnull
public InbDeliveryHeaderDeleteFluentHelper deleteInbDeliveryHeader(@Nonnull
                                                                            InbDeliveryHeader inbDeliveryHeader)

Description copied from interface: InboundDeliveryService

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

Specified by:

deleteInbDeliveryHeader in interface InboundDeliveryService

Parameters:

inbDeliveryHeader - InbDeliveryHeader entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllInbDeliveryItem

@Nonnull
public InbDeliveryItemFluentHelper getAllInbDeliveryItem()

Description copied from interface: InboundDeliveryService

Fetch multiple InbDeliveryItem entities.

Specified by:

getAllInbDeliveryItem in interface InboundDeliveryService

Returns:

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

getInbDeliveryItemByKey

@Nonnull
public InbDeliveryItemByKeyFluentHelper getInbDeliveryItemByKey(String deliveryDocument,
                                                                         String deliveryDocumentItem)

Description copied from interface: InboundDeliveryService

Fetch a single InbDeliveryItem entity using key fields.

Specified by:

getInbDeliveryItemByKey in interface InboundDeliveryService

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 InbDeliveryItem 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.

updateInbDeliveryItem

@Nonnull
public InbDeliveryItemUpdateFluentHelper updateInbDeliveryItem(@Nonnull
                                                                        InbDeliveryItem inbDeliveryItem)

Description copied from interface: InboundDeliveryService

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

Specified by:

updateInbDeliveryItem in interface InboundDeliveryService

Parameters:

inbDeliveryItem - InbDeliveryItem entity object that will be updated in the S/4HANA system.

Returns:

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

deleteInbDeliveryItem

@Nonnull
public InbDeliveryItemDeleteFluentHelper deleteInbDeliveryItem(@Nonnull
                                                                        InbDeliveryItem inbDeliveryItem)

Description copied from interface: InboundDeliveryService

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

Specified by:

deleteInbDeliveryItem in interface InboundDeliveryService

Parameters:

inbDeliveryItem - InbDeliveryItem entity object that will be deleted in the S/4HANA system.

Returns:

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

confirmPutawayAllItems

@Nonnull
public ConfirmPutawayAllItemsFluentHelper confirmPutawayAllItems(String deliveryDocument)

Description copied from interface: InboundDeliveryService

Creates a fluent helper for the ConfirmPutawayAllItems OData function import.

Specified by:

confirmPutawayAllItems in interface InboundDeliveryService

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: InboundDeliveryService

Creates a fluent helper for the ConfirmPutawayOneItem OData function import.

Specified by:

confirmPutawayOneItem in interface InboundDeliveryService

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.

postGoodsReceipt

@Nonnull
public PostGoodsReceiptFluentHelper postGoodsReceipt(String deliveryDocument)

Description copied from interface: InboundDeliveryService

Creates a fluent helper for the PostGoodsReceipt OData function import.

Specified by:

postGoodsReceipt in interface InboundDeliveryService

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.

putawayAllItems

@Nonnull
public PutawayAllItemsFluentHelper putawayAllItems(String deliveryDocument)

Description copied from interface: InboundDeliveryService

Creates a fluent helper for the PutawayAllItems OData function import.

Specified by:

putawayAllItems in interface InboundDeliveryService

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: InboundDeliveryService

Creates a fluent helper for the PutawayOneItem OData function import.

Specified by:

putawayOneItem in interface InboundDeliveryService

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.

reverseGoodsReceipt

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

Description copied from interface: InboundDeliveryService

Creates a fluent helper for the ReverseGoodsReceipt OData function import.

Specified by:

reverseGoodsReceipt in interface InboundDeliveryService

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

actualGoodsMovementDate - Actual GI Date

Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: ActualGoodsMovementDate

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.