com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface MaterialPlanningDataService

All Superinterfaces:

BatchService<MaterialPlanningDataServiceBatch>

All Known Implementing Classes:

DefaultMaterialPlanningDataService

public interface MaterialPlanningDataService
extends BatchService<MaterialPlanningDataServiceBatch>

Reading planning data 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 - Process Manufacturing Based on Process Order (BJ8), Material Requirements Planning (J44)
Authentication Methods:	Basic, x509

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
MaterialCoverageFluentHelper	getAllMaterialCoverage() Fetch multiple MaterialCoverage entities.
MRPMaterialFluentHelper	getAllMRPMaterial() Fetch multiple MRPMaterial entities.
SupplyDemandItemFluentHelper	getAllSupplyDemandItem() Fetch multiple SupplyDemandItem entities.
MaterialCoverageByKeyFluentHelper	getMaterialCoverageByKey(String material, String materialShortageProfile, String materialShortageProfileCount, String mRPArea, String mRPPlanningSegmentNumber, String mRPPlanningSegmentType, String mRPPlant) Fetch a single MaterialCoverage entity using key fields.
MRPMaterialByKeyFluentHelper	getMRPMaterialByKey(String material, String mRPPlant, String mRPArea) Fetch a single MRPMaterial entity using key fields.
MaterialPlanningDataService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
MaterialPlanningDataService withServicePath(@Nonnull
                                                     String servicePath)

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

getAllMaterialCoverage

@Nonnull
MaterialCoverageFluentHelper getAllMaterialCoverage()

Fetch multiple MaterialCoverage entities.

Returns:

A fluent helper to fetch multiple 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 execute method on the fluent helper object.

getMaterialCoverageByKey

@Nonnull
MaterialCoverageByKeyFluentHelper getMaterialCoverageByKey(String material,
                                                                    String materialShortageProfile,
                                                                    String materialShortageProfileCount,
                                                                    String mRPArea,
                                                                    String mRPPlanningSegmentNumber,
                                                                    String mRPPlanningSegmentType,
                                                                    String mRPPlant)

Fetch a single MaterialCoverage entity using key fields.

Parameters:

mRPArea -

material -

mRPPlanningSegmentType -

mRPPlant -

materialShortageProfile -

materialShortageProfileCount -

mRPPlanningSegmentNumber -

Returns:

A fluent helper to fetch a single 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 execute method on the fluent helper object.

getAllSupplyDemandItem

@Nonnull
SupplyDemandItemFluentHelper getAllSupplyDemandItem()

Fetch multiple SupplyDemandItem entities.

Returns:

A fluent helper to fetch multiple 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 execute method on the fluent helper object.

getAllMRPMaterial

@Nonnull
MRPMaterialFluentHelper getAllMRPMaterial()

Fetch multiple MRPMaterial entities.

Returns:

A fluent helper to fetch multiple 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 execute method on the fluent helper object.

getMRPMaterialByKey

@Nonnull
MRPMaterialByKeyFluentHelper getMRPMaterialByKey(String material,
                                                          String mRPPlant,
                                                          String mRPArea)

Fetch a single MRPMaterial entity using key fields.

Parameters:

mRPArea - Number of the MRP area for which material requirements planning should be carried out separately.

Constraints: Not nullable, Maximum length: 10

material - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 40

mRPPlant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single 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 execute method on the fluent helper object.