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

Class DefaultOutboundDeliveryService

java.lang.Object

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

All Implemented Interfaces:

BatchService<OutboundDeliveryServiceBatch>, OutboundDeliveryService

Deprecated.

The service and all its related classes are deprecated as of release 1911 (NOV-2019). Please use the successor API instead.

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

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

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_OUTBOUND_DELIVERY_SRV
API Version:	1
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

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultOutboundDeliveryService() Deprecated. Creates a service using OutboundDeliveryService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultOutboundDeliveryServiceBatch	batch() Deprecated. Instantiate a new FluentHelper instance for a single OData batch request.
ConfirmPickingAllItemsFluentHelper	confirmPickingAllItems(String deliveryDocument) Deprecated. Creates a fluent helper for the ConfirmPickingAllItems OData function import.
ConfirmPickingOneItemFluentHelper	confirmPickingOneItem(String deliveryDocumentItem, String deliveryDocument) Deprecated. Creates a fluent helper for the ConfirmPickingOneItem OData function import.
OutbDeliveryHeaderCreateFluentHelper	createOutbDeliveryHeader(OutbDeliveryHeader outbDeliveryHeader) Deprecated. Create a new OutbDeliveryHeader entity and save it to the S/4HANA system.
OutbDeliveryHeaderDeleteFluentHelper	deleteOutbDeliveryHeader(OutbDeliveryHeader outbDeliveryHeader) Deprecated. Deletes an existing OutbDeliveryHeader entity in the S/4HANA system.
OutbDeliveryItemDeleteFluentHelper	deleteOutbDeliveryItem(OutbDeliveryItem outbDeliveryItem) Deprecated. Deletes an existing OutbDeliveryItem entity in the S/4HANA system.
OutbDeliveryHeaderFluentHelper	getAllOutbDeliveryHeader() Deprecated. Fetch multiple OutbDeliveryHeader entities.
OutbDeliveryItemFluentHelper	getAllOutbDeliveryItem() Deprecated. Fetch multiple OutbDeliveryItem entities.
OutbDeliveryDocFlowByKeyFluentHelper	getOutbDeliveryDocFlowByKey(String precedingDocument, String precedingDocumentItem, String subsequentDocumentCategory) Deprecated. Fetch a single OutbDeliveryDocFlow entity using key fields.
OutbDeliveryHeaderByKeyFluentHelper	getOutbDeliveryHeaderByKey(String deliveryDocument) Deprecated. Fetch a single OutbDeliveryHeader entity using key fields.
OutbDeliveryItemByKeyFluentHelper	getOutbDeliveryItemByKey(String deliveryDocument, String deliveryDocumentItem) Deprecated. Fetch a single OutbDeliveryItem entity using key fields.
OutbDeliveryPartnerByKeyFluentHelper	getOutbDeliveryPartnerByKey(String partnerFunction, String sDDocument) Deprecated. Fetch a single OutbDeliveryPartner entity using key fields.
SerialNmbrDeliveryByKeyFluentHelper	getSerialNmbrDeliveryByKey(Integer maintenanceItemObjectList) Deprecated. Fetch a single SerialNmbrDelivery entity using key fields.
PickAllItemsFluentHelper	pickAllItems(String deliveryDocument) Deprecated. Creates a fluent helper for the PickAllItems OData function import.
PickOneItemFluentHelper	pickOneItem(String deliveryDocument, String deliveryDocumentItem) Deprecated. Creates a fluent helper for the PickOneItem OData function import.
PostGoodsIssueFluentHelper	postGoodsIssue(String deliveryDocument) Deprecated. Creates a fluent helper for the PostGoodsIssue OData function import.
ReverseGoodsIssueFluentHelper	reverseGoodsIssue(String deliveryDocument, LocalDateTime actualGoodsMovementDate) Deprecated. Creates a fluent helper for the ReverseGoodsIssue OData function import.
OutbDeliveryDocFlowUpdateFluentHelper	updateOutbDeliveryDocFlow(OutbDeliveryDocFlow outbDeliveryDocFlow) Deprecated. Update an existing OutbDeliveryDocFlow entity and save it to the S/4HANA system.
OutbDeliveryHeaderUpdateFluentHelper	updateOutbDeliveryHeader(OutbDeliveryHeader outbDeliveryHeader) Deprecated. Update an existing OutbDeliveryHeader entity and save it to the S/4HANA system.
OutbDeliveryItemUpdateFluentHelper	updateOutbDeliveryItem(OutbDeliveryItem outbDeliveryItem) Deprecated. Update an existing OutbDeliveryItem entity and save it to the S/4HANA system.
DefaultOutboundDeliveryService	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

Constructor Detail

DefaultOutboundDeliveryService

public DefaultOutboundDeliveryService()

Deprecated.

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

Method Detail

withServicePath

@Nonnull
public DefaultOutboundDeliveryService withServicePath(@Nonnull
                                                               String servicePath)

Deprecated.

Description copied from interface: OutboundDeliveryService

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 OutboundDeliveryService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultOutboundDeliveryServiceBatch batch()

Deprecated.

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

Specified by:

batch in interface BatchService<OutboundDeliveryServiceBatch>

Returns:

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

getAllOutbDeliveryItem

@Nonnull
public OutbDeliveryItemFluentHelper getAllOutbDeliveryItem()

Deprecated.

Description copied from interface: OutboundDeliveryService

Fetch multiple OutbDeliveryItem entities.

Specified by:

getAllOutbDeliveryItem in interface OutboundDeliveryService

Returns:

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

getOutbDeliveryItemByKey

@Nonnull
public OutbDeliveryItemByKeyFluentHelper getOutbDeliveryItemByKey(String deliveryDocument,
                                                                           String deliveryDocumentItem)

Deprecated.

Description copied from interface: OutboundDeliveryService

Fetch a single OutbDeliveryItem entity using key fields.

Specified by:

getOutbDeliveryItemByKey in interface OutboundDeliveryService

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

updateOutbDeliveryItem

@Nonnull
public OutbDeliveryItemUpdateFluentHelper updateOutbDeliveryItem(@Nonnull
                                                                          OutbDeliveryItem outbDeliveryItem)

Deprecated.

Description copied from interface: OutboundDeliveryService

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

Specified by:

updateOutbDeliveryItem in interface OutboundDeliveryService

Parameters:

outbDeliveryItem - OutbDeliveryItem entity object that will be updated in the S/4HANA system.

Returns:

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

deleteOutbDeliveryItem

@Nonnull
public OutbDeliveryItemDeleteFluentHelper deleteOutbDeliveryItem(@Nonnull
                                                                          OutbDeliveryItem outbDeliveryItem)

Deprecated.

Description copied from interface: OutboundDeliveryService

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

Specified by:

deleteOutbDeliveryItem in interface OutboundDeliveryService

Parameters:

outbDeliveryItem - OutbDeliveryItem entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllOutbDeliveryHeader

@Nonnull
public OutbDeliveryHeaderFluentHelper getAllOutbDeliveryHeader()

Deprecated.

Description copied from interface: OutboundDeliveryService

Fetch multiple OutbDeliveryHeader entities.

Specified by:

getAllOutbDeliveryHeader in interface OutboundDeliveryService

Returns:

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

getOutbDeliveryHeaderByKey

@Nonnull
public OutbDeliveryHeaderByKeyFluentHelper getOutbDeliveryHeaderByKey(String deliveryDocument)

Deprecated.

Description copied from interface: OutboundDeliveryService

Fetch a single OutbDeliveryHeader entity using key fields.

Specified by:

getOutbDeliveryHeaderByKey in interface OutboundDeliveryService

Parameters:

deliveryDocument - The number that uniquely identifies the delivery.

Constraints: Not nullable, Maximum length: 10

Returns:

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

createOutbDeliveryHeader

@Nonnull
public OutbDeliveryHeaderCreateFluentHelper createOutbDeliveryHeader(@Nonnull
                                                                              OutbDeliveryHeader outbDeliveryHeader)

Deprecated.

Description copied from interface: OutboundDeliveryService

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

Specified by:

createOutbDeliveryHeader in interface OutboundDeliveryService

Parameters:

outbDeliveryHeader - OutbDeliveryHeader entity object that will be created in the S/4HANA system.

Returns:

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

updateOutbDeliveryHeader

@Nonnull
public OutbDeliveryHeaderUpdateFluentHelper updateOutbDeliveryHeader(@Nonnull
                                                                              OutbDeliveryHeader outbDeliveryHeader)

Deprecated.

Description copied from interface: OutboundDeliveryService

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

Specified by:

updateOutbDeliveryHeader in interface OutboundDeliveryService

Parameters:

outbDeliveryHeader - OutbDeliveryHeader entity object that will be updated in the S/4HANA system.

Returns:

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

deleteOutbDeliveryHeader

@Nonnull
public OutbDeliveryHeaderDeleteFluentHelper deleteOutbDeliveryHeader(@Nonnull
                                                                              OutbDeliveryHeader outbDeliveryHeader)

Deprecated.

Description copied from interface: OutboundDeliveryService

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

Specified by:

deleteOutbDeliveryHeader in interface OutboundDeliveryService

Parameters:

outbDeliveryHeader - OutbDeliveryHeader entity object that will be deleted in the S/4HANA system.

Returns:

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

getOutbDeliveryDocFlowByKey

@Nonnull
public OutbDeliveryDocFlowByKeyFluentHelper getOutbDeliveryDocFlowByKey(String precedingDocument,
                                                                                 String precedingDocumentItem,
                                                                                 String subsequentDocumentCategory)

Deprecated.

Description copied from interface: OutboundDeliveryService

Fetch a single OutbDeliveryDocFlow entity using key fields.

Specified by:

getOutbDeliveryDocFlowByKey in interface OutboundDeliveryService

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

updateOutbDeliveryDocFlow

@Nonnull
public OutbDeliveryDocFlowUpdateFluentHelper updateOutbDeliveryDocFlow(@Nonnull
                                                                                OutbDeliveryDocFlow outbDeliveryDocFlow)

Deprecated.

Description copied from interface: OutboundDeliveryService

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

Specified by:

updateOutbDeliveryDocFlow in interface OutboundDeliveryService

Parameters:

outbDeliveryDocFlow - OutbDeliveryDocFlow entity object that will be updated in the S/4HANA system.

Returns:

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

getSerialNmbrDeliveryByKey

@Nonnull
public SerialNmbrDeliveryByKeyFluentHelper getSerialNmbrDeliveryByKey(Integer maintenanceItemObjectList)

Deprecated.

Description copied from interface: OutboundDeliveryService

Fetch a single SerialNmbrDelivery entity using key fields.

Specified by:

getSerialNmbrDeliveryByKey in interface OutboundDeliveryService

Returns:

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

getOutbDeliveryPartnerByKey

@Nonnull
public OutbDeliveryPartnerByKeyFluentHelper getOutbDeliveryPartnerByKey(String partnerFunction,
                                                                                 String sDDocument)

Deprecated.

Description copied from interface: OutboundDeliveryService

Fetch a single OutbDeliveryPartner entity using key fields.

Specified by:

getOutbDeliveryPartnerByKey in interface OutboundDeliveryService

Parameters:

partnerFunction - The abbreviated form of the name that identifies the partner function.

Constraints: Not nullable, Maximum length: 2

sDDocument - The number that uniquely identifies the sales, delivery, or billing document.

Constraints: Not nullable, Maximum length: 10

Returns:

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

postGoodsIssue

@Nonnull
public PostGoodsIssueFluentHelper postGoodsIssue(@Nonnull
                                                          String deliveryDocument)

Deprecated.

Description copied from interface: OutboundDeliveryService

Creates a fluent helper for the PostGoodsIssue OData function import.

Specified by:

postGoodsIssue in interface OutboundDeliveryService

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 PostGoodsIssue OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

reverseGoodsIssue

@Nonnull
public ReverseGoodsIssueFluentHelper reverseGoodsIssue(@Nonnull
                                                                String deliveryDocument,
                                                                @Nonnull
                                                                LocalDateTime actualGoodsMovementDate)

Deprecated.

Description copied from interface: OutboundDeliveryService

Creates a fluent helper for the ReverseGoodsIssue OData function import.

Specified by:

reverseGoodsIssue in interface OutboundDeliveryService

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 ReverseGoodsIssue OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

confirmPickingAllItems

@Nonnull
public ConfirmPickingAllItemsFluentHelper confirmPickingAllItems(@Nonnull
                                                                          String deliveryDocument)

Deprecated.

Description copied from interface: OutboundDeliveryService

Creates a fluent helper for the ConfirmPickingAllItems OData function import.

Specified by:

confirmPickingAllItems in interface OutboundDeliveryService

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 ConfirmPickingAllItems OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

confirmPickingOneItem

@Nonnull
public ConfirmPickingOneItemFluentHelper confirmPickingOneItem(@Nonnull
                                                                        String deliveryDocumentItem,
                                                                        @Nonnull
                                                                        String deliveryDocument)

Deprecated.

Description copied from interface: OutboundDeliveryService

Creates a fluent helper for the ConfirmPickingOneItem OData function import.

Specified by:

confirmPickingOneItem in interface OutboundDeliveryService

Parameters:

deliveryDocumentItem - Item

Constraints: Not nullable, Maximum length: 6

Original parameter name from the Odata EDM: DeliveryDocumentItem

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 ConfirmPickingOneItem OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

pickAllItems

@Nonnull
public PickAllItemsFluentHelper pickAllItems(@Nonnull
                                                      String deliveryDocument)

Deprecated.

Description copied from interface: OutboundDeliveryService

Creates a fluent helper for the PickAllItems OData function import.

Specified by:

pickAllItems in interface OutboundDeliveryService

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 PickAllItems OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

pickOneItem

@Nonnull
public PickOneItemFluentHelper pickOneItem(@Nonnull
                                                    String deliveryDocument,
                                                    @Nonnull
                                                    String deliveryDocumentItem)

Deprecated.

Description copied from interface: OutboundDeliveryService

Creates a fluent helper for the PickOneItem OData function import.

Specified by:

pickOneItem in interface OutboundDeliveryService

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 PickOneItem OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.