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

Interface ProductionOrderService

All Known Implementing Classes:

DefaultProductionOrderService

public interface ProductionOrderService

You can use this service to read header data, items, operations, components, and the status of production orders. With this API, it is also possible to release a production order or an operation of a production order.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PRODUCTION_ORDERS
API Version:	1
Communication Scenario:	Production Planning Integration (SAP_COM_0104)
Scope Items:	Material Requirements Planning (J44)

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
ProductionOrderFluentHelper	getAllProductionOrder() Fetch multiple ProductionOrder entities.
ProductionOrderComponentFluentHelper	getAllProductionOrderComponent() Fetch multiple ProductionOrderComponent entities.
ProductionOrderItemFluentHelper	getAllProductionOrderItem() Fetch multiple ProductionOrderItem entities.
ProductionOrderOperationFluentHelper	getAllProductionOrderOperation() Fetch multiple ProductionOrderOperation entities.
ProductionOrderStatusFluentHelper	getAllProductionOrderStatus() Fetch multiple ProductionOrderStatus entities.
ProductionRsceToolsFluentHelper	getAllProductionRsceTools() Fetch multiple ProductionRsceTools entities.
ProductionOrderByKeyFluentHelper	getProductionOrderByKey(String productionOrder) Fetch a single ProductionOrder entity using key fields.
ProductionOrderComponentByKeyFluentHelper	getProductionOrderComponentByKey(String reservation, String reservationItem) Fetch a single ProductionOrderComponent entity using key fields.
ProductionOrderItemByKeyFluentHelper	getProductionOrderItemByKey(String manufacturingOrder, String manufacturingOrderItem) Fetch a single ProductionOrderItem entity using key fields.
ProductionOrderOperationByKeyFluentHelper	getProductionOrderOperationByKey(String orderInternalBillOfOperations, String orderIntBillOfOperationsItem) Fetch a single ProductionOrderOperation entity using key fields.
ProductionOrderStatusByKeyFluentHelper	getProductionOrderStatusByKey(String manufacturingOrder, String statusCode) Fetch a single ProductionOrderStatus entity using key fields.
ProductionRsceToolsByKeyFluentHelper	getProductionRsceToolsByKey(String orderInternalBillOfOperations, String mfgOrderOpProdnRsceToolIntID) Fetch a single ProductionRsceTools entity using key fields.
ReleaseProductionOrderFluentHelper	releaseProductionOrder(String manufacturingOrder) Creates a fluent helper for the ReleaseProductionOrder OData function import.
ReleaseProductionOrderOprFluentHelper	releaseProductionOrderOpr(String manufacturingOrder, String manufacturingOrderOperation) Creates a fluent helper for the ReleaseProductionOrderOpr OData function import.
ProductionOrderService	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

ProductionOrderService 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

getAllProductionOrder

@Nonnull
ProductionOrderFluentHelper getAllProductionOrder()

Fetch multiple ProductionOrder entities.

Returns:

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

getProductionOrderByKey

@Nonnull
ProductionOrderByKeyFluentHelper getProductionOrderByKey(String productionOrder)

Fetch a single ProductionOrder entity using key fields.

Parameters:

productionOrder - Manufacturing Order ID

Constraints: Not nullable, Maximum length: 12

Returns:

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

getAllProductionOrderComponent

@Nonnull
ProductionOrderComponentFluentHelper getAllProductionOrderComponent()

Fetch multiple ProductionOrderComponent entities.

Returns:

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

getProductionOrderComponentByKey

@Nonnull
ProductionOrderComponentByKeyFluentHelper getProductionOrderComponentByKey(String reservation,
                                                                                    String reservationItem)

Fetch a single ProductionOrderComponent entity using key fields.

Parameters:

reservationItem - Reservation Item

Constraints: Not nullable, Maximum length: 4

reservation - Number of Reservation/Dependent Requirement

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllProductionOrderItem

@Nonnull
ProductionOrderItemFluentHelper getAllProductionOrderItem()

Fetch multiple ProductionOrderItem entities.

Returns:

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

getProductionOrderItemByKey

@Nonnull
ProductionOrderItemByKeyFluentHelper getProductionOrderItemByKey(String manufacturingOrder,
                                                                          String manufacturingOrderItem)

Fetch a single ProductionOrderItem entity using key fields.

Parameters:

manufacturingOrderItem - Manufacturing Order Item ID

Constraints: Not nullable, Maximum length: 4

manufacturingOrder - Manufacturing Order ID

Constraints: Not nullable, Maximum length: 12

Returns:

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

getAllProductionOrderOperation

@Nonnull
ProductionOrderOperationFluentHelper getAllProductionOrderOperation()

Fetch multiple ProductionOrderOperation entities.

Returns:

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

getProductionOrderOperationByKey

@Nonnull
ProductionOrderOperationByKeyFluentHelper getProductionOrderOperationByKey(String orderInternalBillOfOperations,
                                                                                    String orderIntBillOfOperationsItem)

Fetch a single ProductionOrderOperation entity using key fields.

Parameters:

orderIntBillOfOperationsItem - Order Internal Bill of Operations Item

Constraints: Not nullable, Maximum length: 8

orderInternalBillOfOperations - Order Internal Bill of Operations ID

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllProductionOrderStatus

@Nonnull
ProductionOrderStatusFluentHelper getAllProductionOrderStatus()

Fetch multiple ProductionOrderStatus entities.

Returns:

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

getProductionOrderStatusByKey

@Nonnull
ProductionOrderStatusByKeyFluentHelper getProductionOrderStatusByKey(String manufacturingOrder,
                                                                              String statusCode)

Fetch a single ProductionOrderStatus entity using key fields.

Parameters:

manufacturingOrder - Order Number

Constraints: Not nullable, Maximum length: 12

statusCode - Object status

Constraints: Not nullable, Maximum length: 5

Returns:

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

getAllProductionRsceTools

@Nonnull
ProductionRsceToolsFluentHelper getAllProductionRsceTools()

Fetch multiple ProductionRsceTools entities.

Returns:

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

getProductionRsceToolsByKey

@Nonnull
ProductionRsceToolsByKeyFluentHelper getProductionRsceToolsByKey(String orderInternalBillOfOperations,
                                                                          String mfgOrderOpProdnRsceToolIntID)

Fetch a single ProductionRsceTools entity using key fields.

Parameters:

mfgOrderOpProdnRsceToolIntID - Item counter for production resources/tools

Constraints: Not nullable, Maximum length: 8

orderInternalBillOfOperations - Routing number of operations in the order

Constraints: Not nullable, Maximum length: 10

Returns:

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

releaseProductionOrder

@Nonnull
ReleaseProductionOrderFluentHelper releaseProductionOrder(String manufacturingOrder)

Creates a fluent helper for the ReleaseProductionOrder OData function import.

Parameters:

manufacturingOrder - Constraints: none

Original parameter name from the Odata EDM: ManufacturingOrder

Returns:

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

releaseProductionOrderOpr

@Nonnull
ReleaseProductionOrderOprFluentHelper releaseProductionOrderOpr(String manufacturingOrder,
                                                                         String manufacturingOrderOperation)

Creates a fluent helper for the ReleaseProductionOrderOpr OData function import.

Parameters:

manufacturingOrderOperation - Constraints: none

Original parameter name from the Odata EDM: ManufacturingOrderOperation

manufacturingOrder - Constraints: none

Original parameter name from the Odata EDM: ManufacturingOrder

Returns:

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