com.sap.cloud.sdk.s4hana.datamodel.odata.services.MaterialPlanningDataService 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.materialplanningdata.MRPMaterialByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialplanningdata.MRPMaterialFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialplanningdata.MaterialCoverageByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialplanningdata.MaterialCoverageFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialplanningdata.SupplyDemandItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialplanningdata.batch.MaterialPlanningDataServiceBatch;

/**
 * 
 * This service enables you to read planning data for materials in Material Requirements Planning (MRP).
 * 
 * This includes material master data as well as supply and demand information for a certain period of time and
 * information about the coverage of materials..
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_MRP_MATERIALS_SRV_01
API Version: 1
Communication Scenario: Production Planning Integration (SAP_COM_0104)
Scope Items: Make-to-Stock Production - Discrete Manufacturing (BJ5),
 * Make-to-Stock Production - Process Manufacturing based on Process
 * Order (BJ8), Material Requirements Planning (J44)
Authentication Methods: Basic, x509, OAuth2
 * 
 */
public interface MaterialPlanningDataService 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_MRP_MATERIALS_SRV_01";

    /**
     * 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
    MaterialPlanningDataService withServicePath( @Nonnull final String servicePath );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialplanningdata.MaterialCoverage
     * MaterialCoverage} entity using key fields.
     * 
     * @param mRPArea
     * 
     * @param material
     * 
     * @param mRPPlanningSegmentType
     * 
     * @param mRPPlant
     * 
     * @param materialShortageProfile
     * 
     * @param materialShortageProfileCount
     * 
     * @param mRPPlanningSegmentNumber
     * 
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialplanningdata.MaterialCoverage
     *         MaterialCoverage} 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.materialplanningdata.MaterialCoverageByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    MaterialCoverageByKeyFluentHelper getMaterialCoverageByKey(
        final String material,
        final String materialShortageProfile,
        final String materialShortageProfileCount,
        final String mRPArea,
        final String mRPPlanningSegmentNumber,
        final String mRPPlanningSegmentType,
        final String mRPPlant );

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

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialplanningdata.MRPMaterial
     * MRPMaterial} entity using key fields.
     * 
     * @param mRPArea
     *            Number of the MRP area for which material requirements planning should be carried out separately.
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @param material
     *            Alphanumeric key uniquely identifying the material.
     *            
     *            Constraints: Not nullable, Maximum length: 40
     *            
     * @param mRPPlant
     *            Key uniquely identifying a plant.
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialplanningdata.MRPMaterial MRPMaterial}
     *         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.materialplanningdata.MRPMaterialByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    MRPMaterialByKeyFluentHelper
        getMRPMaterialByKey( final String material, final String mRPPlant, final String mRPArea );

}
OData Service:	API_MRP_MATERIALS_SRV_01
API Version:	1
Communication Scenario:	Production Planning Integration (SAP_COM_0104)
Scope Items:	Make-to-Stock Production - Discrete Manufacturing (BJ5), * Make-to-Stock Production - Process Manufacturing based on Process * Order (BJ8), Material Requirements Planning (J44)
Authentication Methods:	Basic, x509, OAuth2