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

Interface PlannedOrderService

All Known Implementing Classes:

DefaultPlannedOrderService

public interface PlannedOrderService

This service enables you to create, change, and delete planned orders as well as to read order headers and components belonging to planned orders.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PLANNED_ORDERS
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)
Authentication Methods:	Basic, x509, OAuth2

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
PlannedOrderCreateFluentHelper	createPlannedOrder(PlannedOrder plannedOrder) Create a new PlannedOrder entity and save it to the S/4HANA system.
PlannedOrderDeleteFluentHelper	deletePlannedOrder(PlannedOrder plannedOrder) Deletes an existing PlannedOrder entity in the S/4HANA system.
PlannedOrderFluentHelper	getAllPlannedOrder() Fetch multiple PlannedOrder entities.
PlannedOrderComponentFluentHelper	getAllPlannedOrderComponent() Fetch multiple PlannedOrderComponent entities.
PlannedOrderByKeyFluentHelper	getPlannedOrderByKey(String plannedOrder) Fetch a single PlannedOrder entity using key fields.
PlannedOrderComponentByKeyFluentHelper	getPlannedOrderComponentByKey(String reservation, String reservationItem) Fetch a single PlannedOrderComponent entity using key fields.
PlannedOrderUpdateFluentHelper	updatePlannedOrder(PlannedOrder plannedOrder) Update an existing PlannedOrder entity and save it to the S/4HANA system.
PlannedOrderService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

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

PlannedOrderService 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

getAllPlannedOrder

@Nonnull
PlannedOrderFluentHelper getAllPlannedOrder()

Fetch multiple PlannedOrder entities.

Returns:

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

getPlannedOrderByKey

@Nonnull
PlannedOrderByKeyFluentHelper getPlannedOrderByKey(String plannedOrder)

Fetch a single PlannedOrder entity using key fields.

Parameters:

plannedOrder - Number that specifically identifies a planned order for a material.

Constraints: Not nullable, Maximum length: 10

Returns:

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

createPlannedOrder

@Nonnull
PlannedOrderCreateFluentHelper createPlannedOrder(@Nonnull
                                                           PlannedOrder plannedOrder)

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

Parameters:

plannedOrder - PlannedOrder entity object that will be created in the S/4HANA system.

Returns:

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

updatePlannedOrder

@Nonnull
PlannedOrderUpdateFluentHelper updatePlannedOrder(@Nonnull
                                                           PlannedOrder plannedOrder)

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

Parameters:

plannedOrder - PlannedOrder entity object that will be updated in the S/4HANA system.

Returns:

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

deletePlannedOrder

@Nonnull
PlannedOrderDeleteFluentHelper deletePlannedOrder(@Nonnull
                                                           PlannedOrder plannedOrder)

Deletes an existing PlannedOrder entity in the S/4HANA system.

Parameters:

plannedOrder - PlannedOrder entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllPlannedOrderComponent

@Nonnull
PlannedOrderComponentFluentHelper getAllPlannedOrderComponent()

Fetch multiple PlannedOrderComponent entities.

Returns:

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

getPlannedOrderComponentByKey

@Nonnull
PlannedOrderComponentByKeyFluentHelper getPlannedOrderComponentByKey(String reservation,
                                                                              String reservationItem)

Fetch a single PlannedOrderComponent entity using key fields.

Parameters:

reservationItem - Reservation Item

Constraints: Not nullable, Maximum length: 4

reservation - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

Returns:

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