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

Class DefaultPlannedOrderService

java.lang.Object

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

All Implemented Interfaces:

PlannedOrderService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultPlannedOrderService")
public class DefaultPlannedOrderService
extends Object
implements 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 inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.PlannedOrderService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultPlannedOrderService() Creates a service using PlannedOrderService.DEFAULT_SERVICE_PATH to send the requests.

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.
DefaultPlannedOrderService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPlannedOrderService

public DefaultPlannedOrderService()

Creates a service using PlannedOrderService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultPlannedOrderService withServicePath(@Nonnull
                                                           String servicePath)

Description copied from interface: PlannedOrderService

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

Specified by:

withServicePath in interface PlannedOrderService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path

getAllPlannedOrder

@Nonnull
public PlannedOrderFluentHelper getAllPlannedOrder()

Description copied from interface: PlannedOrderService

Fetch multiple PlannedOrder entities.

Specified by:

getAllPlannedOrder in interface PlannedOrderService

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
public PlannedOrderByKeyFluentHelper getPlannedOrderByKey(String plannedOrder)

Description copied from interface: PlannedOrderService

Fetch a single PlannedOrder entity using key fields.

Specified by:

getPlannedOrderByKey in interface PlannedOrderService

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
public PlannedOrderCreateFluentHelper createPlannedOrder(@Nonnull
                                                                  PlannedOrder plannedOrder)

Description copied from interface: PlannedOrderService

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

Specified by:

createPlannedOrder in interface PlannedOrderService

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
public PlannedOrderUpdateFluentHelper updatePlannedOrder(@Nonnull
                                                                  PlannedOrder plannedOrder)

Description copied from interface: PlannedOrderService

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

Specified by:

updatePlannedOrder in interface PlannedOrderService

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
public PlannedOrderDeleteFluentHelper deletePlannedOrder(@Nonnull
                                                                  PlannedOrder plannedOrder)

Description copied from interface: PlannedOrderService

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

Specified by:

deletePlannedOrder in interface PlannedOrderService

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
public PlannedOrderComponentFluentHelper getAllPlannedOrderComponent()

Description copied from interface: PlannedOrderService

Fetch multiple PlannedOrderComponent entities.

Specified by:

getAllPlannedOrderComponent in interface PlannedOrderService

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
public PlannedOrderComponentByKeyFluentHelper getPlannedOrderComponentByKey(String reservation,
                                                                                     String reservationItem)

Description copied from interface: PlannedOrderService

Fetch a single PlannedOrderComponent entity using key fields.

Specified by:

getPlannedOrderComponentByKey in interface PlannedOrderService

Parameters:

reservation - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

reservationItem - Reservation Item

Constraints: Not nullable, Maximum length: 4

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.