com.sap.cloud.sdk.s4hana.datamodel.odata.services.SalesOrderSimulateService Maven / Gradle / Ivy

Go to download

/*
 * 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.salesordersimulate.SalesOrderSimulation;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesordersimulate.SalesOrderSimulationCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesordersimulate.batch.SalesOrderSimulateServiceBatch;

/**
 * 
 * You can use this service to integrate external applications that simulate the creation of sales orders in SAP S/4HANA
 * Cloud. This simulation includes price calculation with results, Available-to- Promise (ATP) check, partner
 * determination and credit check.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_SALES_ORDER_SIMULATION_SRV
API Version: 1
Communication Scenario: Sales Order Integration (SAP_COM_0109)
Scope Items: Sell from Stock (BD9),
 * Opportunity-to-Order with Third-Party Sales Force Automation Apps
 * (1QI)
Authentication Methods: Basic, x509
Business Object: SalesOrder
 * 
 */
public interface SalesOrderSimulateService 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_ORDER_SIMULATION_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
    SalesOrderSimulateService withServicePath( @Nonnull final String servicePath );

    /**
     * Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesordersimulate.SalesOrderSimulation
     * SalesOrderSimulation} entity and save it to the S/4HANA system.
     * 
     * @param salesOrderSimulation
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesordersimulate.SalesOrderSimulation
     *            SalesOrderSimulation} 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.salesordersimulate.SalesOrderSimulation
     *         SalesOrderSimulation} entity. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesordersimulate.SalesOrderSimulationCreateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    SalesOrderSimulationCreateFluentHelper
        createSalesOrderSimulation( @Nonnull final SalesOrderSimulation salesOrderSimulation );

}

OData Service:	API_SALES_ORDER_SIMULATION_SRV
API Version:	1
Communication Scenario:	Sales Order Integration (SAP_COM_0109)
Scope Items:	Sell from Stock (BD9), * Opportunity-to-Order with Third-Party Sales Force Automation Apps * (1QI)
Authentication Methods:	Basic, x509
Business Object:	SalesOrder