com.sap.cloud.sdk.s4hana.datamodel.odata.services.MaterialStockDisplayService 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.materialstockdisplay.MaterialStockByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialstockdisplay.MaterialStockFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialstockdisplay.MatlStkInAcctModByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialstockdisplay.MatlStkInAcctModFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialstockdisplay.batch.MaterialStockDisplayServiceBatch;

/**
 * 
 * This service enables you to retrieve material stock information using the OData protocol with filter data provided in
 * the payload. It can be consumed by external warehouse applications.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_MATERIAL_STOCK_SRV
API Version: 1
Communication Scenario: Material Stock Integration (SAP_COM_0164)
Scope Items: Core Inventory Management (BMC)
 * 
 */
public interface MaterialStockDisplayService 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_MATERIAL_STOCK_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
    MaterialStockDisplayService withServicePath( @Nonnull final String servicePath );

    /**
     * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialstockdisplay.MaterialStock
     * MaterialStock} entities.
     * 
     * @return A fluent helper to fetch multiple
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialstockdisplay.MaterialStock
     *         MaterialStock} 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.materialstockdisplay.MaterialStockFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    MaterialStockFluentHelper getAllMaterialStock();

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialstockdisplay.MaterialStock
     * MaterialStock} entity using key fields.
     * 
     * @param material
     *            Material Number
     *            
     *            Constraints: Not nullable, Maximum length: 40
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialstockdisplay.MaterialStock
     *         MaterialStock} 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.materialstockdisplay.MaterialStockByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    MaterialStockByKeyFluentHelper getMaterialStockByKey( final String material );

    /**
     * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialstockdisplay.MatlStkInAcctMod
     * MatlStkInAcctMod} entities.
     * 
     * @return A fluent helper to fetch multiple
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialstockdisplay.MatlStkInAcctMod
     *         MatlStkInAcctMod} 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.materialstockdisplay.MatlStkInAcctModFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    MatlStkInAcctModFluentHelper getAllMatlStkInAcctMod();

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialstockdisplay.MatlStkInAcctMod
     * MatlStkInAcctMod} entity using key fields.
     * 
     * @param material
     *            Material in Respect of Which Stock is Managed
     *            
     *            Constraints: Not nullable, Maximum length: 40
     *            
     * @param inventorySpecialStockType
     *            Special Stock Indicator
     *            
     *            Constraints: Not nullable, Maximum length: 1
     *            
     * @param wBSElementInternalID
     *            Valuated Sales Order Stock WBS Element
     *            
     *            Constraints: Not nullable, Maximum length: 24
     *            
     * @param plant
     *            Plant
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param supplier
     *            Account Number of Supplier or Creditor (Stock Identifier)
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @param batch
     *            Batch Number (Stock Identifier)
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @param storageLocation
     *            Storage Location
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param sDDocumentItem
     *            Sales Order Item of Valuated Sales Order Stock
     *            
     *            Constraints: Not nullable, Maximum length: 6
     *            
     * @param inventoryStockType
     *            Stock Type of Goods Movement (Stock Identifier)
     *            
     *            Constraints: Not nullable, Maximum length: 2
     *            
     * @param sDDocument
     *            Sales Order Number of Valuated Sales Order Stock
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @param customer
     *            Customer Number (Stock Identifier)
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialstockdisplay.MatlStkInAcctMod
     *         MatlStkInAcctMod} 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.materialstockdisplay.MatlStkInAcctModByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    MatlStkInAcctModByKeyFluentHelper getMatlStkInAcctModByKey(
        final String material,
        final String inventorySpecialStockType,
        final String inventoryStockType,
        final String plant,
        final String storageLocation,
        final String batch,
        final String supplier,
        final String customer,
        final String wBSElementInternalID,
        final String sDDocument,
        final String sDDocumentItem );

}
OData Service:	API_MATERIAL_STOCK_SRV
API Version:	1
Communication Scenario:	Material Stock Integration (SAP_COM_0164)
Scope Items:	Core Inventory Management (BMC)