
com.sap.cloud.sdk.s4hana.datamodel.odata.services.SupplierQuotationService 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.supplierquotation.CancelFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.CompleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.CreateFromRFQFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SubmitFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SubmitForApprovalFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotation;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationItem;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationItemUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.batch.SupplierQuotationServiceBatch;
/**
*
* This service enables a remote system to read, create (with reference to RFQ) and update supplier quotations from / in
* the SAP S/4HANA tenant.
*
*
*
* Reference: SAP API
* Business Hub
*
* Details:
*
*
* OData Service:
* API_QTN_PROCESS_SRV
*
*
* API Version:
* 1
*
*
* Communication Scenario:
* Distributed Manufacturing Integration (SAP_COM_0077), Purchase Request for Quotation Integration
* (SAP_COM_0113)
*
*
* Scope Items:
* Collaborative on-demand manufacturing with SAP Digital
* Manufacturing Cloud (1NX), Consumable Purchasing (BNX),
* SAP Ariba Sourcing Integration (1A0),
* SAP Ariba Quote Automation Integration (1L2),
* Request for Price (1XF)
*
*
* Authentication Methods:
* Basic, x509
*
*
*
*/
public interface SupplierQuotationService 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_QTN_PROCESS_SRV";
/**
* 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
SupplierQuotationService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotation
* SupplierQuotation} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotation
* SupplierQuotation} 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.supplierquotation.SupplierQuotationFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SupplierQuotationFluentHelper getAllSupplierQuotation();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotation
* SupplierQuotation} entity using key fields.
*
* @param supplierQuotation
* Supplier Quotation Number
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotation
* SupplierQuotation} 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.supplierquotation.SupplierQuotationByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SupplierQuotationByKeyFluentHelper getSupplierQuotationByKey( final String supplierQuotation );
/**
* Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotation
* SupplierQuotation} entity and save it to the S/4HANA system.
*
* @param supplierQuotation
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotation
* SupplierQuotation} 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.supplierquotation.SupplierQuotation
* SupplierQuotation} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SupplierQuotationCreateFluentHelper createSupplierQuotation( @Nonnull final SupplierQuotation supplierQuotation );
/**
* Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotation
* SupplierQuotation} entity and save it to the S/4HANA system.
*
* @param supplierQuotation
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotation
* SupplierQuotation} 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.supplierquotation.SupplierQuotation
* SupplierQuotation} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SupplierQuotationUpdateFluentHelper updateSupplierQuotation( @Nonnull final SupplierQuotation supplierQuotation );
/**
* Deletes an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotation SupplierQuotation}
* entity in the S/4HANA system.
*
* @param supplierQuotation
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotation
* SupplierQuotation} 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.supplierquotation.SupplierQuotation
* SupplierQuotation} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationDeleteFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SupplierQuotationDeleteFluentHelper deleteSupplierQuotation( @Nonnull final SupplierQuotation supplierQuotation );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationItem
* SupplierQuotationItem} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationItem
* SupplierQuotationItem} 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.supplierquotation.SupplierQuotationItemFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SupplierQuotationItemFluentHelper getAllSupplierQuotationItem();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationItem
* SupplierQuotationItem} entity using key fields.
*
* @param supplierQuotationItem
* Item Number of Supplier Quotation
*
* Constraints: Not nullable, Maximum length: 5
*
* @param supplierQuotation
* Alphanumeric key uniquely identifying the document.
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationItem
* SupplierQuotationItem} 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.supplierquotation.SupplierQuotationItemByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SupplierQuotationItemByKeyFluentHelper
getSupplierQuotationItemByKey( final String supplierQuotation, final String supplierQuotationItem );
/**
* Update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationItem
* SupplierQuotationItem} entity and save it to the S/4HANA system.
*
* @param supplierQuotationItem
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationItem
* SupplierQuotationItem} 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.supplierquotation.SupplierQuotationItem
* SupplierQuotationItem} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SupplierQuotationItemUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SupplierQuotationItemUpdateFluentHelper
updateSupplierQuotationItem( @Nonnull final SupplierQuotationItem supplierQuotationItem );
/**
* Submit Supplier Quotation
*
*
*
* Creates a fluent helper for the Submit OData function import.
*
*
* @param supplierQuotation
* Supplier Quotation
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: SupplierQuotation
*
* @return A fluent helper object that will execute the Submit OData function import with the provided
* parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SubmitFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SubmitFluentHelper submit( final String supplierQuotation );
/**
* Complete Bidding
*
*
*
* Creates a fluent helper for the Complete OData function import.
*
*
* @param supplierQuotation
* Supplier Quotation
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: SupplierQuotation
*
* @return A fluent helper object that will execute the Complete OData function import with the provided
* parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.CompleteFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
CompleteFluentHelper complete( final String supplierQuotation );
/**
* Cancel Supplier Quotation
*
*
*
* Creates a fluent helper for the Cancel OData function import.
*
*
* @param supplierQuotation
* Supplier Quotation
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: SupplierQuotation
*
* @return A fluent helper object that will execute the Cancel OData function import with the provided
* parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.CancelFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
CancelFluentHelper cancel( final String supplierQuotation );
/**
* Submit Supplier Quotation for approval
*
*
*
* Creates a fluent helper for the SubmitForApproval OData function import.
*
*
* @param supplierQuotation
* Supplier Quotation
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: SupplierQuotation
*
* @return A fluent helper object that will execute the SubmitForApproval OData function import with the
* provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.SubmitForApprovalFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SubmitForApprovalFluentHelper submitForApproval( final String supplierQuotation );
/**
* Create QTN from RFQ (including all itms)
*
*
*
* Creates a fluent helper for the CreateFromRFQ OData function import.
*
*
* @param supplier
* Supplier
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: Supplier
*
* @param quotationSubmissionDate
* Quotation Submission Date
*
*
*
* Constraints: Not nullable, Precision: 0
*
*
* Original parameter name from the Odata EDM: QuotationSubmissionDate
*
* @param requestForQuotation
* Request for Quotation
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: RequestForQuotation
*
* @return A fluent helper object that will execute the CreateFromRFQ OData function import with the provided
* parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierquotation.CreateFromRFQFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
CreateFromRFQFluentHelper createFromRFQ(
final LocalDateTime quotationSubmissionDate,
final String supplier,
final String requestForQuotation );
}