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

Interface BufferSizingService

All Superinterfaces:

BatchService<BufferSizingServiceBatch>

All Known Implementing Classes:

DefaultBufferSizingService

public interface BufferSizingService
extends BatchService<BufferSizingServiceBatch>

The service contains header and item entities. For read operations, filter information must be sent according to the OData protocol. All filter information is utilized when retrieving buffer sizing data, such as, buffer proposals, average daily usage (ADU), decoupled lead time (DLT), demand and zone adjustments. The buffer proposal, ADU, DLT, longest path in BOM, and actual stock level details are sent in the response. If any issues arise when buffer sizing details are retrieved, the system displays error messages in the response..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_BUFFERSIZING_SRV
API Version:	1
Communication Scenario:	Buffer Sizing Integration (SAP_COM_0359)
Scope Items:	Demand-Driven Buffer Level Management (1Y2)
Authentication Methods:	Basic, x509
Business Object:	Product

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
AdoptFluentHelper	adopt(String material, String plant, String mRPArea, LocalDateTime proposalStartDate, String proposalVersion) Creates a fluent helper for the Adopt OData function import.
ProposalHeaderCreateFluentHelper	createProposalHeader(ProposalHeader proposalHeader) Create a new ProposalHeader entity and save it to the S/4HANA system.
DiscardFluentHelper	discard(String material, String plant, String mRPArea, LocalDateTime proposalStartDate, String proposalVersion) Creates a fluent helper for the Discard OData function import.
ActualStockByKeyFluentHelper	getActualStockByKey(String material, String plant, String mRPArea, LocalDateTime bufferLevelStartDate) Fetch a single ActualStock entity using key fields.
ActualStockFluentHelper	getAllActualStock() Fetch multiple ActualStock entities.
DemandAdjustmentFactorsFluentHelper	getAllDemandAdjustmentFactors() Fetch multiple DemandAdjustmentFactors entities.
DemandAdjustmentsFluentHelper	getAllDemandAdjustments() Fetch multiple DemandAdjustments entities.
LongestPathInBOMFluentHelper	getAllLongestPathInBOM() Fetch multiple LongestPathInBOM entities.
ProposalHeaderFluentHelper	getAllProposalHeader() Fetch multiple ProposalHeader entities.
ZoneAdjustmentsFluentHelper	getAllZoneAdjustments() Fetch multiple ZoneAdjustments entities.
DemandAdjustmentFactorsByKeyFluentHelper	getDemandAdjustmentFactorsByKey(String material, String plant, String mRPArea, LocalDateTime proposalStartDate, String proposalVersion, LocalDateTime proposalDmndAdjmtFctrStartDate) Fetch a single DemandAdjustmentFactors entity using key fields.
DemandAdjustmentsByKeyFluentHelper	getDemandAdjustmentsByKey(String material, String plant, String mRPArea, LocalDateTime proposalStartDate, String proposalVersion, LocalDateTime proposalDmndAdjmtFctrStartDate) Fetch a single DemandAdjustments entity using key fields.
LongestPathInBOMByKeyFluentHelper	getLongestPathInBOMByKey(String material, String plant, String mRPArea, LocalDateTime proposalStartDate, String proposalVersion, UUID billOfMaterialUUID, String parentComponent, String parentPlant, String billOfMaterialComponent, String componentPlant) Fetch a single LongestPathInBOM entity using key fields.
ProposalHeaderByKeyFluentHelper	getProposalHeaderByKey(String material, String plant, String mRPArea, LocalDateTime proposalStartDate, String proposalVersion) Fetch a single ProposalHeader entity using key fields.
ZoneAdjustmentsByKeyFluentHelper	getZoneAdjustmentsByKey(String material, String plant, String mRPArea, LocalDateTime proposalStartDate, String proposalVersion, LocalDateTime bufPrpslZoneAdjmtFctrStartDate) Fetch a single ZoneAdjustments entity using key fields.
ResumeFluentHelper	resume(String material, String plant, String mRPArea, LocalDateTime proposalStartDate, String proposalVersion) Creates a fluent helper for the Resume OData function import.
SuspendFluentHelper	suspend(String material, String plant, String mRPArea, LocalDateTime proposalStartDate, String proposalVersion, String stockLevelProposalStatus, LocalDateTime proposalRunSuspendedFromDate, LocalDateTime proposalRunSuspendedToDate) Creates a fluent helper for the Suspend OData function import.
DemandAdjustmentFactorsUpdateFluentHelper	updateDemandAdjustmentFactors(DemandAdjustmentFactors demandAdjustmentFactors) Update an existing DemandAdjustmentFactors entity and save it to the S/4HANA system.
DemandAdjustmentsUpdateFluentHelper	updateDemandAdjustments(DemandAdjustments demandAdjustments) Update an existing DemandAdjustments entity and save it to the S/4HANA system.
ZoneAdjustmentsUpdateFluentHelper	updateZoneAdjustments(ZoneAdjustments zoneAdjustments) Update an existing ZoneAdjustments entity and save it to the S/4HANA system.
BufferSizingService	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
BufferSizingService 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.

getAllDemandAdjustments

@Nonnull
DemandAdjustmentsFluentHelper getAllDemandAdjustments()

Fetch multiple DemandAdjustments entities.

Returns:

A fluent helper to fetch multiple DemandAdjustments 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.

getDemandAdjustmentsByKey

@Nonnull
DemandAdjustmentsByKeyFluentHelper getDemandAdjustmentsByKey(String material,
                                                                      String plant,
                                                                      String mRPArea,
                                                                      LocalDateTime proposalStartDate,
                                                                      String proposalVersion,
                                                                      LocalDateTime proposalDmndAdjmtFctrStartDate)

Fetch a single DemandAdjustments 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

proposalDmndAdjmtFctrStartDate - Proposal Details Valid From

Constraints: Not nullable, Precision: 0

material - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 18

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

proposalVersion - Proposal Version

Constraints: Not nullable, Maximum length: 8

proposalStartDate - Proposal Validity From Date

Constraints: Not nullable, Precision: 0

Returns:

A fluent helper to fetch a single DemandAdjustments 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.

updateDemandAdjustments

@Nonnull
DemandAdjustmentsUpdateFluentHelper updateDemandAdjustments(@Nonnull
                                                                     DemandAdjustments demandAdjustments)

Update an existing DemandAdjustments entity and save it to the S/4HANA system.

Parameters:

demandAdjustments - DemandAdjustments entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing DemandAdjustments entity. To perform execution, call the execute method on the fluent helper object.

getAllDemandAdjustmentFactors

@Nonnull
DemandAdjustmentFactorsFluentHelper getAllDemandAdjustmentFactors()

Fetch multiple DemandAdjustmentFactors entities.

Returns:

A fluent helper to fetch multiple DemandAdjustmentFactors 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.

getDemandAdjustmentFactorsByKey

@Nonnull
DemandAdjustmentFactorsByKeyFluentHelper getDemandAdjustmentFactorsByKey(String material,
                                                                                  String plant,
                                                                                  String mRPArea,
                                                                                  LocalDateTime proposalStartDate,
                                                                                  String proposalVersion,
                                                                                  LocalDateTime proposalDmndAdjmtFctrStartDate)

Fetch a single DemandAdjustmentFactors 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

proposalDmndAdjmtFctrStartDate - Proposal Details Valid From

Constraints: Not nullable, Precision: 0

material - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 18

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

proposalVersion - Proposal Version

Constraints: Not nullable, Maximum length: 8

proposalStartDate - Proposal Validity From Date

Constraints: Not nullable, Precision: 0

Returns:

A fluent helper to fetch a single DemandAdjustmentFactors 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.

updateDemandAdjustmentFactors

@Nonnull
DemandAdjustmentFactorsUpdateFluentHelper updateDemandAdjustmentFactors(@Nonnull
                                                                                 DemandAdjustmentFactors demandAdjustmentFactors)

Update an existing DemandAdjustmentFactors entity and save it to the S/4HANA system.

Parameters:

demandAdjustmentFactors - DemandAdjustmentFactors entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing DemandAdjustmentFactors entity. To perform execution, call the execute method on the fluent helper object.

getAllZoneAdjustments

@Nonnull
ZoneAdjustmentsFluentHelper getAllZoneAdjustments()

Fetch multiple ZoneAdjustments entities.

Returns:

A fluent helper to fetch multiple ZoneAdjustments 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.

getZoneAdjustmentsByKey

@Nonnull
ZoneAdjustmentsByKeyFluentHelper getZoneAdjustmentsByKey(String material,
                                                                  String plant,
                                                                  String mRPArea,
                                                                  LocalDateTime proposalStartDate,
                                                                  String proposalVersion,
                                                                  LocalDateTime bufPrpslZoneAdjmtFctrStartDate)

Fetch a single ZoneAdjustments 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: 18

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

bufPrpslZoneAdjmtFctrStartDate - Proposal Zones Valid From

Constraints: Not nullable, Precision: 0

proposalVersion - Proposal Version

Constraints: Not nullable, Maximum length: 8

proposalStartDate - Proposal Validity From Date

Constraints: Not nullable, Precision: 0

Returns:

A fluent helper to fetch a single ZoneAdjustments 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.

updateZoneAdjustments

@Nonnull
ZoneAdjustmentsUpdateFluentHelper updateZoneAdjustments(@Nonnull
                                                                 ZoneAdjustments zoneAdjustments)

Update an existing ZoneAdjustments entity and save it to the S/4HANA system.

Parameters:

zoneAdjustments - ZoneAdjustments entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing ZoneAdjustments entity. To perform execution, call the execute method on the fluent helper object.

getAllProposalHeader

@Nonnull
ProposalHeaderFluentHelper getAllProposalHeader()

Fetch multiple ProposalHeader entities.

Returns:

A fluent helper to fetch multiple ProposalHeader 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.

getProposalHeaderByKey

@Nonnull
ProposalHeaderByKeyFluentHelper getProposalHeaderByKey(String material,
                                                                String plant,
                                                                String mRPArea,
                                                                LocalDateTime proposalStartDate,
                                                                String proposalVersion)

Fetch a single ProposalHeader 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: 18

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

proposalVersion - Proposal Version

Constraints: Not nullable, Maximum length: 8

proposalStartDate - Proposal Validity From Date

Constraints: Not nullable, Precision: 0

Returns:

A fluent helper to fetch a single ProposalHeader 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.

createProposalHeader

@Nonnull
ProposalHeaderCreateFluentHelper createProposalHeader(@Nonnull
                                                               ProposalHeader proposalHeader)

Create a new ProposalHeader entity and save it to the S/4HANA system.

Parameters:

proposalHeader - ProposalHeader entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ProposalHeader entity. To perform execution, call the execute method on the fluent helper object.

getAllActualStock

@Nonnull
ActualStockFluentHelper getAllActualStock()

Fetch multiple ActualStock entities.

Returns:

A fluent helper to fetch multiple ActualStock 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.

getActualStockByKey

@Nonnull
ActualStockByKeyFluentHelper getActualStockByKey(String material,
                                                          String plant,
                                                          String mRPArea,
                                                          LocalDateTime bufferLevelStartDate)

Fetch a single ActualStock 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: 18

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

bufferLevelStartDate - Valid-From Date

Constraints: Not nullable, Precision: 0

Returns:

A fluent helper to fetch a single ActualStock 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.

getAllLongestPathInBOM

@Nonnull
LongestPathInBOMFluentHelper getAllLongestPathInBOM()

Fetch multiple LongestPathInBOM entities.

Returns:

A fluent helper to fetch multiple LongestPathInBOM 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.

getLongestPathInBOMByKey

@Nonnull
LongestPathInBOMByKeyFluentHelper getLongestPathInBOMByKey(String material,
                                                                    String plant,
                                                                    String mRPArea,
                                                                    LocalDateTime proposalStartDate,
                                                                    String proposalVersion,
                                                                    UUID billOfMaterialUUID,
                                                                    String parentComponent,
                                                                    String parentPlant,
                                                                    String billOfMaterialComponent,
                                                                    String componentPlant)

Fetch a single LongestPathInBOM 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: 18

billOfMaterialComponent - Material number of the components that you enter, change or display as part of the BOM.

Constraints: Not nullable, Maximum length: 18

billOfMaterialUUID - Internal Key for BOMID

Constraints: Not nullable

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

parentComponent - Parent BOM Component

Constraints: Not nullable, Maximum length: 18

componentPlant - Component Plant

Constraints: Not nullable, Maximum length: 4

proposalVersion - Proposal Version

Constraints: Not nullable, Maximum length: 8

parentPlant - Parent Plant

Constraints: Not nullable, Maximum length: 4

proposalStartDate - Proposal Validity From Date

Constraints: Not nullable, Precision: 0

Returns:

A fluent helper to fetch a single LongestPathInBOM 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.

adopt

@Nonnull
AdoptFluentHelper adopt(String material,
                                 String plant,
                                 String mRPArea,
                                 LocalDateTime proposalStartDate,
                                 String proposalVersion)

Creates a fluent helper for the Adopt OData function import.

Parameters:

mRPArea - MRP Area

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: MRPArea

material - Material

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: Material

plant - Plant

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Plant

proposalVersion - Proposal Version

Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: ProposalVersion

proposalStartDate - Proposal Valid From

Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: ProposalStartDate

Returns:

A fluent helper object that will execute the Adopt OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

discard

@Nonnull
DiscardFluentHelper discard(String material,
                                     String plant,
                                     String mRPArea,
                                     LocalDateTime proposalStartDate,
                                     String proposalVersion)

Creates a fluent helper for the Discard OData function import.

Parameters:

mRPArea - MRP Area

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: MRPArea

material - Material

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: Material

plant - Plant

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Plant

proposalVersion - Proposal Version

Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: ProposalVersion

proposalStartDate - Proposal Valid From

Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: ProposalStartDate

Returns:

A fluent helper object that will execute the Discard OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

resume

@Nonnull
ResumeFluentHelper resume(String material,
                                   String plant,
                                   String mRPArea,
                                   LocalDateTime proposalStartDate,
                                   String proposalVersion)

Creates a fluent helper for the Resume OData function import.

Parameters:

mRPArea - MRP Area

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: MRPArea

material - Material

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: Material

plant - Plant

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Plant

proposalVersion - Proposal Version

Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: ProposalVersion

proposalStartDate - Proposal Valid From

Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: ProposalStartDate

Returns:

A fluent helper object that will execute the Resume OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

suspend

@Nonnull
SuspendFluentHelper suspend(String material,
                                     String plant,
                                     String mRPArea,
                                     LocalDateTime proposalStartDate,
                                     String proposalVersion,
                                     String stockLevelProposalStatus,
                                     LocalDateTime proposalRunSuspendedFromDate,
                                     LocalDateTime proposalRunSuspendedToDate)

Creates a fluent helper for the Suspend OData function import.

Parameters:

proposalRunSuspendedToDate - Prpsl Run Susp End

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: ProposalRunSuspendedToDate

mRPArea - MRP Area

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: MRPArea

material - Material

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: Material

plant - Plant

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Plant

proposalVersion - Proposal Version

Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: ProposalVersion

proposalRunSuspendedFromDate - Prpsl Run Susp Start

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: ProposalRunSuspendedFromDate

stockLevelProposalStatus - Proposal Status

Constraints: Nullable, Maximum length: 1

Original parameter name from the Odata EDM: StockLevelProposalStatus

proposalStartDate - Proposal Valid From

Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: ProposalStartDate

Returns:

A fluent helper object that will execute the Suspend OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.