com.sap.cloud.sdk.s4hana.datamodel.odata.services.PlannedIndependentRequirementService 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 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.plannedindependentrequirement.MaintainYearsPeriod;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedindependentrequirement.MaintainYearsPeriodByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedindependentrequirement.MaintainYearsPeriodFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedindependentrequirement.MaintainYearsPeriodUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedindependentrequirement.batch.PlannedIndependentRequirementServiceBatch;

/**
 * 
 * This inbound/outbound service enables you to read and update planned independent requirements (PIRs). Use this API if
 * you want to work with the Manage PIRs app and not the Change PIRs app. If you work with the Change PIRs app as you
 * require the additional flexibility provided in this app, you are recommended to use the following API:
 * 
 * https://api.sap.com/shell/discover/contentp ackage/SAPS4HANACloud/api/API_PLND_INDE P_RQMT_SRV .
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_FORECAST_DEMAND_SRV
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 (BJ8),
 * Material Requirements Planning (J44)
 * 
 */
public interface PlannedIndependentRequirementService 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_FORECAST_DEMAND_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
    PlannedIndependentRequirementService withServicePath( @Nonnull final String servicePath );

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

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedindependentrequirement.MaintainYearsPeriod
     * MaintainYearsPeriod} 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 forecastDemandVersion
     *            Alphanumeric description of a demand program, also known as the (demand) version number.
     *            
     *            Constraints: Not nullable, Maximum length: 2
     *            
     * @param plant
     *            Key uniquely identifying a plant.
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param requirementsType
     *            The requirements type determines the planning strategy to be used for a particular requirement.
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param forecastPeriodStartDate
     *            Period Start Date
     *            
     *            Constraints: Not nullable, Precision: 7
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedindependentrequirement.MaintainYearsPeriod
     *         MaintainYearsPeriod} 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.plannedindependentrequirement.MaintainYearsPeriodByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    MaintainYearsPeriodByKeyFluentHelper getMaintainYearsPeriodByKey(
        final String material,
        final String plant,
        final String mRPArea,
        final String requirementsType,
        final String forecastDemandVersion,
        final LocalDateTime forecastPeriodStartDate );

    /**
     * Update an existing
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedindependentrequirement.MaintainYearsPeriod
     * MaintainYearsPeriod} entity and save it to the S/4HANA system.
     * 
     * @param maintainYearsPeriod
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedindependentrequirement.MaintainYearsPeriod
     *            MaintainYearsPeriod} 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.plannedindependentrequirement.MaintainYearsPeriod
     *         MaintainYearsPeriod} entity. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedindependentrequirement.MaintainYearsPeriodUpdateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    MaintainYearsPeriodUpdateFluentHelper
        updateMaintainYearsPeriod( @Nonnull final MaintainYearsPeriod maintainYearsPeriod );

}
OData Service:	API_FORECAST_DEMAND_SRV
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 (BJ8), * Material Requirements Planning (J44)