com.sap.cloud.sdk.s4hana.datamodel.odata.services.InboundDeliveryService Maven / Gradle / Ivy
/*
* Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
*/
package com.sap.cloud.sdk.s4hana.datamodel.odata.services;
import java.time.LocalDateTime;
import javax.annotation.Nonnull;
import com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.ConfirmPutawayAllItemsFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.ConfirmPutawayOneItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryDocFlow;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryDocFlowByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryDocFlowUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeader;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeaderByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeaderCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeaderDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeaderFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeaderUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItem;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItemDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItemUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.PostGoodsReceiptFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.PutawayAllItemsFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.PutawayOneItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.ReverseGoodsReceiptFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.batch.InboundDeliveryServiceBatch;
/**
*
* 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.
*
*
*
* 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
*
*
*
*/
public interface InboundDeliveryService extends BatchService
{
/**
* If no other path was provided via the {@link #withServicePath(String)} method, this is the default service path
* used to access the endpoint.
*
*/
String DEFAULT_SERVICE_PATH = "/sap/opu/odata/sap/API_INBOUND_DELIVERY_SRV;v=0002";
/**
* Overrides the default service path and returns a new service instance with the specified service path. Also
* adjusts the respective entity URLs.
*
* @param servicePath
* Service path that will override the default.
* @return A new service instance with the specified service path.
*/
@Nonnull
InboundDeliveryService withServicePath( @Nonnull final String servicePath );
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryDocFlow
* InbDeliveryDocFlow} entity using key fields.
*
* @param 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
*
* @param precedingDocumentItem
* Preceding Item of an SD Document
*
* Constraints: Not nullable, Maximum length: 6
*
* @param 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
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryDocFlow
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryDocFlowByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InbDeliveryDocFlowByKeyFluentHelper getInbDeliveryDocFlowByKey(
final String precedingDocument,
final String precedingDocumentItem,
final String subsequentDocumentCategory );
/**
* Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryDocFlow
* InbDeliveryDocFlow} entity and save it to the S/4HANA system.
*
* @param inbDeliveryDocFlow
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryDocFlow
* InbDeliveryDocFlow} entity object that will be updated in the S/4HANA system.
* @return A fluent helper to update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryDocFlow
* InbDeliveryDocFlow} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryDocFlowUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InbDeliveryDocFlowUpdateFluentHelper
updateInbDeliveryDocFlow( @Nonnull final InbDeliveryDocFlow inbDeliveryDocFlow );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeader
* InbDeliveryHeader} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeader
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeaderFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InbDeliveryHeaderFluentHelper getAllInbDeliveryHeader();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeader
* InbDeliveryHeader} entity using key fields.
*
* @param deliveryDocument
* The number that uniquely identifies the delivery.
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeader
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeaderByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InbDeliveryHeaderByKeyFluentHelper getInbDeliveryHeaderByKey( final String deliveryDocument );
/**
* Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeader
* InbDeliveryHeader} entity and save it to the S/4HANA system.
*
* @param inbDeliveryHeader
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeader
* InbDeliveryHeader} entity object that will be created in the S/4HANA system.
* @return A fluent helper to create a new
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeader
* InbDeliveryHeader} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeaderCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InbDeliveryHeaderCreateFluentHelper createInbDeliveryHeader( @Nonnull final InbDeliveryHeader inbDeliveryHeader );
/**
* Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeader
* InbDeliveryHeader} entity and save it to the S/4HANA system.
*
* @param inbDeliveryHeader
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeader
* InbDeliveryHeader} entity object that will be updated in the S/4HANA system.
* @return A fluent helper to update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeader
* InbDeliveryHeader} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeaderUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InbDeliveryHeaderUpdateFluentHelper updateInbDeliveryHeader( @Nonnull final InbDeliveryHeader inbDeliveryHeader );
/**
* Deletes an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeader
* InbDeliveryHeader} entity in the S/4HANA system.
*
* @param inbDeliveryHeader
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeader
* InbDeliveryHeader} entity object that will be deleted in the S/4HANA system.
* @return A fluent helper to delete an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeader
* InbDeliveryHeader} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryHeaderDeleteFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InbDeliveryHeaderDeleteFluentHelper deleteInbDeliveryHeader( @Nonnull final InbDeliveryHeader inbDeliveryHeader );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItem
* InbDeliveryItem} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItem
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItemFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InbDeliveryItemFluentHelper getAllInbDeliveryItem();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItem
* InbDeliveryItem} entity using key fields.
*
* @param deliveryDocument
* The number that uniquely identifies the delivery.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param deliveryDocumentItem
* The number that uniquely identifies the item in a delivery.
*
* Constraints: Not nullable, Maximum length: 6
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItem
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItemByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InbDeliveryItemByKeyFluentHelper
getInbDeliveryItemByKey( final String deliveryDocument, final String deliveryDocumentItem );
/**
* Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItem
* InbDeliveryItem} entity and save it to the S/4HANA system.
*
* @param inbDeliveryItem
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItem
* InbDeliveryItem} entity object that will be updated in the S/4HANA system.
* @return A fluent helper to update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItem
* InbDeliveryItem} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItemUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InbDeliveryItemUpdateFluentHelper updateInbDeliveryItem( @Nonnull final InbDeliveryItem inbDeliveryItem );
/**
* Deletes an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItem
* InbDeliveryItem} entity in the S/4HANA system.
*
* @param inbDeliveryItem
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItem
* InbDeliveryItem} entity object that will be deleted in the S/4HANA system.
* @return A fluent helper to delete an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItem
* InbDeliveryItem} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.InbDeliveryItemDeleteFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InbDeliveryItemDeleteFluentHelper deleteInbDeliveryItem( @Nonnull final InbDeliveryItem inbDeliveryItem );
/**
*
* Creates a fluent helper for the ConfirmPutawayAllItems OData function import.
*
*
* @param deliveryDocument
* Delivery
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: DeliveryDocument
*
* @return A fluent helper object that will execute the ConfirmPutawayAllItems OData function import with the
* provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.ConfirmPutawayAllItemsFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ConfirmPutawayAllItemsFluentHelper confirmPutawayAllItems( final String deliveryDocument );
/**
*
* Creates a fluent helper for the ConfirmPutawayOneItem OData function import.
*
*
* @param deliveryDocument
* Delivery
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: DeliveryDocument
*
* @param deliveryDocumentItem
* Item
*
*
*
* Constraints: Not nullable, Maximum length: 6
*
*
* Original parameter name from the Odata EDM: DeliveryDocumentItem
*
* @return A fluent helper object that will execute the ConfirmPutawayOneItem OData function import with the
* provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.ConfirmPutawayOneItemFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ConfirmPutawayOneItemFluentHelper
confirmPutawayOneItem( final String deliveryDocument, final String deliveryDocumentItem );
/**
*
* Creates a fluent helper for the PostGoodsReceipt OData function import.
*
*
* @param deliveryDocument
* Delivery
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: DeliveryDocument
*
* @return A fluent helper object that will execute the PostGoodsReceipt OData function import with the
* provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.PostGoodsReceiptFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PostGoodsReceiptFluentHelper postGoodsReceipt( final String deliveryDocument );
/**
*
* Creates a fluent helper for the PutawayAllItems OData function import.
*
*
* @param deliveryDocument
* Delivery
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: DeliveryDocument
*
* @return A fluent helper object that will execute the PutawayAllItems OData function import with the
* provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.PutawayAllItemsFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PutawayAllItemsFluentHelper putawayAllItems( final String deliveryDocument );
/**
*
* Creates a fluent helper for the PutawayOneItem OData function import.
*
*
* @param deliveryDocument
* Delivery
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: DeliveryDocument
*
* @param deliveryDocumentItem
* Item
*
*
*
* Constraints: Not nullable, Maximum length: 6
*
*
* Original parameter name from the Odata EDM: DeliveryDocumentItem
*
* @return A fluent helper object that will execute the PutawayOneItem OData function import with the
* provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.PutawayOneItemFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PutawayOneItemFluentHelper putawayOneItem( final String deliveryDocument, final String deliveryDocumentItem );
/**
*
* Creates a fluent helper for the ReverseGoodsReceipt OData function import.
*
*
* @param deliveryDocument
* Delivery
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: DeliveryDocument
*
* @param actualGoodsMovementDate
* Actual GI Date
*
*
*
* Constraints: Not nullable, Precision: 0
*
*
* Original parameter name from the Odata EDM: ActualGoodsMovementDate
*
* @return A fluent helper object that will execute the ReverseGoodsReceipt OData function import with the
* provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inbounddelivery.ReverseGoodsReceiptFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ReverseGoodsReceiptFluentHelper
reverseGoodsReceipt( final String deliveryDocument, final LocalDateTime actualGoodsMovementDate );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy