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

Interface PlannedOrderService

All Superinterfaces:

BatchService<PlannedOrderServiceBatch>

All Known Implementing Classes:

DefaultPlannedOrderService

public interface PlannedOrderService
extends BatchService<PlannedOrderServiceBatch>

In addition to executing the operations on planned orders, you can also read, create, change, and delete components belonging to the orders. This service enables you to schedule planned orders operations.

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

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.
PlannedOrderComponentCreateFluentHelper	createPlannedOrderComponent(PlannedOrderComponent plannedOrderComponent) Create a new PlannedOrderComponent entity and save it to the S/4HANA system.
PlannedOrderDeleteFluentHelper	deletePlannedOrder(PlannedOrder plannedOrder) Deletes an existing PlannedOrder entity in the S/4HANA system.
PlannedOrderComponentDeleteFluentHelper	deletePlannedOrderComponent(PlannedOrderComponent plannedOrderComponent) Deletes an existing PlannedOrderComponent entity in the S/4HANA system.
PlannedOrderFluentHelper	getAllPlannedOrder() Fetch multiple PlannedOrder entities.
PlannedOrderCapacityFluentHelper	getAllPlannedOrderCapacity() Fetch multiple PlannedOrderCapacity entities.
PlannedOrderComponentFluentHelper	getAllPlannedOrderComponent() Fetch multiple PlannedOrderComponent entities.
PlannedOrderByKeyFluentHelper	getPlannedOrderByKey(String plannedOrder) Fetch a single PlannedOrder entity using key fields.
PlannedOrderCapacityByKeyFluentHelper	getPlannedOrderCapacityByKey(String capacityRequirement, String capacityRequirementItem, String capacityRqmtItemCapacity) Fetch a single PlannedOrderCapacity entity using key fields.
PlannedOrderComponentByKeyFluentHelper	getPlannedOrderComponentByKey(String reservation, String reservationItem) Fetch a single PlannedOrderComponent entity using key fields.
PlannedOrderScheduleFluentHelper	plannedOrderSchedule(String plannedOrder) Creates a fluent helper for the PlannedOrderSchedule OData function import.
SchedulePlannedOrderOperationFluentHelper	schedulePlannedOrderOperation(String plannedOrder, String capacityRequirement, String capacityRequirementItem, String capacityRqmtItemCapacity, LocalDateTime opSchedldStartDate, LocalTime opSchedldStartTime, LocalDateTime opSchedldEndDate, LocalTime opSchedldEndTime, String opSchedulingMode, String opSchedulingStatus, String opSchedulingStrategy) Creates a fluent helper for the SchedulePlannedOrderOperation OData function import.
PlannedOrderUpdateFluentHelper	updatePlannedOrder(PlannedOrder plannedOrder) Update an existing PlannedOrder entity and save it to the S/4HANA system.
PlannedOrderComponentUpdateFluentHelper	updatePlannedOrderComponent(PlannedOrderComponent plannedOrderComponent) Update an existing PlannedOrderComponent 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.

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
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.

getAllPlannedOrderCapacity

@Nonnull
PlannedOrderCapacityFluentHelper getAllPlannedOrderCapacity()

Fetch multiple PlannedOrderCapacity entities.

Returns:

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

getPlannedOrderCapacityByKey

@Nonnull
PlannedOrderCapacityByKeyFluentHelper getPlannedOrderCapacityByKey(String capacityRequirement,
                                                                            String capacityRequirementItem,
                                                                            String capacityRqmtItemCapacity)

Fetch a single PlannedOrderCapacity entity using key fields.

Parameters:

capacityRequirementItem - Capacity Requirement Item

Constraints: Not nullable, Maximum length: 8

capacityRequirement - ID of the Capacity Requirements Record

Constraints: Not nullable, Maximum length: 12

capacityRqmtItemCapacity - Individual Capacity of a Capacity Requirement Item

Constraints: Not nullable, Maximum length: 4

Returns:

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

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.

createPlannedOrderComponent

@Nonnull
PlannedOrderComponentCreateFluentHelper createPlannedOrderComponent(@Nonnull
                                                                             PlannedOrderComponent plannedOrderComponent)

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

Parameters:

plannedOrderComponent - PlannedOrderComponent entity object that will be created in the S/4HANA system.

Returns:

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

updatePlannedOrderComponent

@Nonnull
PlannedOrderComponentUpdateFluentHelper updatePlannedOrderComponent(@Nonnull
                                                                             PlannedOrderComponent plannedOrderComponent)

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

Parameters:

plannedOrderComponent - PlannedOrderComponent entity object that will be updated in the S/4HANA system.

Returns:

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

deletePlannedOrderComponent

@Nonnull
PlannedOrderComponentDeleteFluentHelper deletePlannedOrderComponent(@Nonnull
                                                                             PlannedOrderComponent plannedOrderComponent)

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

Parameters:

plannedOrderComponent - PlannedOrderComponent entity object that will be deleted in the S/4HANA system.

Returns:

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

plannedOrderSchedule

@Nonnull
PlannedOrderScheduleFluentHelper plannedOrderSchedule(@Nonnull
                                                               String plannedOrder)

Creates a fluent helper for the PlannedOrderSchedule OData function import.

Parameters:

plannedOrder - Planned Order

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: PlannedOrder

Returns:

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

schedulePlannedOrderOperation

@Nonnull
SchedulePlannedOrderOperationFluentHelper schedulePlannedOrderOperation(@Nonnull
                                                                                 String plannedOrder,
                                                                                 @Nonnull
                                                                                 String capacityRequirement,
                                                                                 @Nonnull
                                                                                 String capacityRequirementItem,
                                                                                 @Nonnull
                                                                                 String capacityRqmtItemCapacity,
                                                                                 @Nullable
                                                                                 LocalDateTime opSchedldStartDate,
                                                                                 @Nullable
                                                                                 LocalTime opSchedldStartTime,
                                                                                 @Nullable
                                                                                 LocalDateTime opSchedldEndDate,
                                                                                 @Nullable
                                                                                 LocalTime opSchedldEndTime,
                                                                                 @Nonnull
                                                                                 String opSchedulingMode,
                                                                                 @Nullable
                                                                                 String opSchedulingStatus,
                                                                                 @Nonnull
                                                                                 String opSchedulingStrategy)

Creates a fluent helper for the SchedulePlannedOrderOperation OData function import.

Parameters:

capacityRequirementItem - Counter

Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: CapacityRequirementItem

opSchedldStartDate - Latest Start Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: OpSchedldStartDate

capacityRequirement - Capacity Requirement

Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: CapacityRequirement

plannedOrder - Planned Order

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: PlannedOrder

capacityRqmtItemCapacity - Counter

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: CapacityRqmtItemCapacity

opSchedulingStrategy - Component of the Version Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: OpSchedulingStrategy

opSchedulingStatus - Status

Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: OpSchedulingStatus

opSchedulingMode - Scheduling type

Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: OpSchedulingMode

opSchedldStartTime - Latest Start Time

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: OpSchedldStartTime

opSchedldEndDate - Latest End Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: OpSchedldEndDate

opSchedldEndTime - Latest End Time

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: OpSchedldEndTime

Returns:

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