com.sap.cloud.sdk.s4hana.datamodel.odata.services.ExtendedPlannedIndependentRequirementService 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.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmt;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtItem;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtItemCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtItemUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtUpdateFluentHelper;
/**
*
* This inbound/outbound service enables you to read, create, and update planned independent requirements (PIRs). Use
* this API if you want to work with the Change PIRs app and not the Manage PIRs app. If you work with the Manage PIRs
* app, however, you are recommended to use the following API:
*
* https://api.sap.com/shell/discover/contentp ackage/SAPS4HANACloud/api/API_FORECAST _DEMAND_SRV .
*
*
*
* Reference: SAP
* API Business Hub
*
* Details:
*
*
* OData Service:
* API_PLND_INDEP_RQMT_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 ExtendedPlannedIndependentRequirementService
{
/**
* 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_PLND_INDEP_RQMT_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
ExtendedPlannedIndependentRequirementService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmt
* PlannedIndepRqmt} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmt
* PlannedIndepRqmt} 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.extendedplannedindependentrequirement.PlannedIndepRqmtFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PlannedIndepRqmtFluentHelper getAllPlannedIndepRqmt();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmt
* PlannedIndepRqmt} entity using key fields.
*
* @param plndIndepRqmtVersion
* Alphanumeric description of a demand program, also known as the (demand) version number.
*
* Constraints: Not nullable, Maximum length: 2
*
* @param product
* Alphanumeric key uniquely identifying the material.
*
* Constraints: Not nullable, Maximum length: 40
*
* @param mRPArea
* Number of the MRP area for which material requirements planning should be carried out separately.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param requirementSegment
* Indicates additional information about the type of requirement. You can freely define which
* requirement segments are satisfied by which stock segments using segmentation strategies in the
* transaction Segmentation Strategy Maintenance .
*
* Constraints: Not nullable, Maximum length: 40
*
* @param plant
* Key uniquely identifying a plant.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param plndIndepRqmtType
* The requirements type determines the planning strategy to be used for a particular requirement.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param requirementPlan
* Key which can be given to create and to identify one or more planned independent requirements.
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmt
* PlannedIndepRqmt} 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.extendedplannedindependentrequirement.PlannedIndepRqmtByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PlannedIndepRqmtByKeyFluentHelper getPlannedIndepRqmtByKey(
final String product,
final String plant,
final String mRPArea,
final String plndIndepRqmtType,
final String plndIndepRqmtVersion,
final String requirementPlan,
final String requirementSegment );
/**
* Create a new
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmt
* PlannedIndepRqmt} entity and save it to the S/4HANA system.
*
* @param plannedIndepRqmt
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmt
* PlannedIndepRqmt} 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.extendedplannedindependentrequirement.PlannedIndepRqmt
* PlannedIndepRqmt} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PlannedIndepRqmtCreateFluentHelper createPlannedIndepRqmt( @Nonnull final PlannedIndepRqmt plannedIndepRqmt );
/**
* Update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmt
* PlannedIndepRqmt} entity and save it to the S/4HANA system.
*
* @param plannedIndepRqmt
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmt
* PlannedIndepRqmt} 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.extendedplannedindependentrequirement.PlannedIndepRqmt
* PlannedIndepRqmt} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PlannedIndepRqmtUpdateFluentHelper updatePlannedIndepRqmt( @Nonnull final PlannedIndepRqmt plannedIndepRqmt );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtItem
* PlannedIndepRqmtItem} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtItem
* PlannedIndepRqmtItem} 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.extendedplannedindependentrequirement.PlannedIndepRqmtItemFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PlannedIndepRqmtItemFluentHelper getAllPlannedIndepRqmtItem();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtItem
* PlannedIndepRqmtItem} entity using key fields.
*
* @param plndIndepRqmtVersion
* Alphanumeric description of a demand program, also known as the (demand) version number.
*
* Constraints: Not nullable, Maximum length: 2
*
* @param product
* Alphanumeric key uniquely identifying the material.
*
* Constraints: Not nullable, Maximum length: 40
*
* @param mRPArea
* Number of the MRP area for which material requirements planning should be carried out separately.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param requirementSegment
* Indicates additional information about the type of requirement. You can freely define which
* requirement segments are satisfied by which stock segments using segmentation strategies in the
* transaction Segmentation Strategy Maintenance .
*
* Constraints: Not nullable, Maximum length: 40
*
* @param periodType
* Type of a Period
*
* Constraints: Not nullable, Maximum length: 1
*
* @param plant
* Key uniquely identifying a plant.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param plndIndepRqmtType
* The requirements type determines the planning strategy to be used for a particular requirement.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param plndIndepRqmtPeriod
* Period Text
*
* Constraints: Not nullable, Maximum length: 8
*
* @param requirementPlan
* Key which can be given to create and to identify one or more planned independent requirements.
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtItem
* PlannedIndepRqmtItem} 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.extendedplannedindependentrequirement.PlannedIndepRqmtItemByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PlannedIndepRqmtItemByKeyFluentHelper getPlannedIndepRqmtItemByKey(
final String product,
final String plant,
final String mRPArea,
final String plndIndepRqmtType,
final String plndIndepRqmtVersion,
final String requirementPlan,
final String requirementSegment,
final String plndIndepRqmtPeriod,
final String periodType );
/**
* Create a new
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtItem
* PlannedIndepRqmtItem} entity and save it to the S/4HANA system.
*
* @param plannedIndepRqmtItem
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtItem
* PlannedIndepRqmtItem} 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.extendedplannedindependentrequirement.PlannedIndepRqmtItem
* PlannedIndepRqmtItem} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtItemCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PlannedIndepRqmtItemCreateFluentHelper
createPlannedIndepRqmtItem( @Nonnull final PlannedIndepRqmtItem plannedIndepRqmtItem );
/**
* Update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtItem
* PlannedIndepRqmtItem} entity and save it to the S/4HANA system.
*
* @param plannedIndepRqmtItem
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtItem
* PlannedIndepRqmtItem} 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.extendedplannedindependentrequirement.PlannedIndepRqmtItem
* PlannedIndepRqmtItem} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.extendedplannedindependentrequirement.PlannedIndepRqmtItemUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PlannedIndepRqmtItemUpdateFluentHelper
updatePlannedIndepRqmtItem( @Nonnull final PlannedIndepRqmtItem plannedIndepRqmtItem );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy