com.sap.cloud.sdk.s4hana.datamodel.odata.services.SalesInquiryService 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 javax.annotation.Nonnull;
import com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItemPartnerByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItemPartnerFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItemPrcgElmntByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItemPrcgElmntFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryPartnerByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryPartnerFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryPrcgElmntByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryPrcgElmntFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.batch.SalesInquiryServiceBatch;
/**
*
* This service enables external applications to integrate with read methods for processing sales inquiries in SAP
* S/4HANA Cloud. It enables you to retrieve sales inquiries in an API call.
*
*
*
* Reference: SAP API
* Business Hub
*
* Details:
*
*
* OData Service:
* API_SALES_INQUIRY_SRV
*
*
* API Version:
* 1
*
*
* Communication Scenario:
* Sales Inquiry Integration (SAP_COM_0117)
*
*
* Scope Items:
* Sales Inquiry (1IQ)
*
*
* Authentication Methods:
* Basic, x509
*
*
* Business Object:
* SalesInquiry
*
*
*
*/
public interface SalesInquiryService 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_SALES_INQUIRY_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
SalesInquiryService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiry SalesInquiry}
* entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiry SalesInquiry}
* 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.salesinquiry.SalesInquiryFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SalesInquiryFluentHelper getAllSalesInquiry();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiry SalesInquiry}
* entity using key fields.
*
* @param salesInquiry
* Sales Inquiry
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiry SalesInquiry} 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.salesinquiry.SalesInquiryByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SalesInquiryByKeyFluentHelper getSalesInquiryByKey( final String salesInquiry );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItem
* SalesInquiryItem} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItem
* SalesInquiryItem} 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.salesinquiry.SalesInquiryItemFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SalesInquiryItemFluentHelper getAllSalesInquiryItem();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItem
* SalesInquiryItem} entity using key fields.
*
* @param salesInquiry
* Sales Inquiry
*
* Constraints: Not nullable, Maximum length: 10
*
* @param salesInquiryItem
* Sales Inquiry Item
*
* Constraints: Not nullable, Maximum length: 6
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItem
* SalesInquiryItem} 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.salesinquiry.SalesInquiryItemByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SalesInquiryItemByKeyFluentHelper
getSalesInquiryItemByKey( final String salesInquiry, final String salesInquiryItem );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItemPartner
* SalesInquiryItemPartner} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItemPartner
* SalesInquiryItemPartner} 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.salesinquiry.SalesInquiryItemPartnerFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SalesInquiryItemPartnerFluentHelper getAllSalesInquiryItemPartner();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItemPartner
* SalesInquiryItemPartner} entity using key fields.
*
* @param partnerFunction
* The abbreviated form of the name that identifies the partner function.
*
* Constraints: Not nullable, Maximum length: 2
*
* @param salesInquiry
* The number that uniquely identifies the sales, delivery, or billing document.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param salesInquiryItem
* The number that uniquely identifies the item in the sales, shipping, or billing document.
*
* Constraints: Not nullable, Maximum length: 6
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItemPartner
* SalesInquiryItemPartner} 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.salesinquiry.SalesInquiryItemPartnerByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SalesInquiryItemPartnerByKeyFluentHelper getSalesInquiryItemPartnerByKey(
final String salesInquiry,
final String salesInquiryItem,
final String partnerFunction );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItemPrcgElmnt
* SalesInquiryItemPrcgElmnt} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItemPrcgElmnt
* SalesInquiryItemPrcgElmnt} 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.salesinquiry.SalesInquiryItemPrcgElmntFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SalesInquiryItemPrcgElmntFluentHelper getAllSalesInquiryItemPrcgElmnt();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItemPrcgElmnt
* SalesInquiryItemPrcgElmnt} entity using key fields.
*
* @param pricingProcedureCounter
* Access number of the conditions within a step in the pricing procedure.
*
* Constraints: Not nullable, Maximum length: 3
*
* @param salesInquiry
* The number that uniquely identifies the sales document.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param salesInquiryItem
* The number that uniquely identifies the condition item.
*
* Constraints: Not nullable, Maximum length: 6
*
* @param pricingProcedureStep
* Number that determines the sequence of the condition within a procedure.
*
* Constraints: Not nullable, Maximum length: 3
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryItemPrcgElmnt
* SalesInquiryItemPrcgElmnt} 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.salesinquiry.SalesInquiryItemPrcgElmntByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SalesInquiryItemPrcgElmntByKeyFluentHelper getSalesInquiryItemPrcgElmntByKey(
final String salesInquiry,
final String salesInquiryItem,
final String pricingProcedureStep,
final String pricingProcedureCounter );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryPartner
* SalesInquiryPartner} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryPartner
* SalesInquiryPartner} 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.salesinquiry.SalesInquiryPartnerFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SalesInquiryPartnerFluentHelper getAllSalesInquiryPartner();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryPartner
* SalesInquiryPartner} entity using key fields.
*
* @param partnerFunction
* The abbreviated form of the name that identifies the partner function.
*
* Constraints: Not nullable, Maximum length: 2
*
* @param salesInquiry
* The number that uniquely identifies the sales, delivery, or billing document.
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryPartner
* SalesInquiryPartner} 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.salesinquiry.SalesInquiryPartnerByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SalesInquiryPartnerByKeyFluentHelper
getSalesInquiryPartnerByKey( final String salesInquiry, final String partnerFunction );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryPrcgElmnt
* SalesInquiryPrcgElmnt} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryPrcgElmnt
* SalesInquiryPrcgElmnt} 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.salesinquiry.SalesInquiryPrcgElmntFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SalesInquiryPrcgElmntFluentHelper getAllSalesInquiryPrcgElmnt();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryPrcgElmnt
* SalesInquiryPrcgElmnt} entity using key fields.
*
* @param pricingProcedureCounter
* Access number of the conditions within a step in the pricing procedure.
*
* Constraints: Not nullable, Maximum length: 3
*
* @param salesInquiry
* The number that uniquely identifies the sales document.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param pricingProcedureStep
* Number that determines the sequence of the condition within a procedure.
*
* Constraints: Not nullable, Maximum length: 3
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesinquiry.SalesInquiryPrcgElmnt
* SalesInquiryPrcgElmnt} 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.salesinquiry.SalesInquiryPrcgElmntByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SalesInquiryPrcgElmntByKeyFluentHelper getSalesInquiryPrcgElmntByKey(
final String salesInquiry,
final String pricingProcedureStep,
final String pricingProcedureCounter );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy