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

Interface ProcessOrderService

All Superinterfaces:

BatchService<ProcessOrderServiceBatch>

All Known Implementing Classes:

DefaultProcessOrderService

public interface ProcessOrderService
extends BatchService<ProcessOrderServiceBatch>

This service enables you to read order headers, items, operations, components, statuses, and production/resource tools (PRTs) belonging to process orders.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PROCESS_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
ProcessOrderFluentHelper	getAllProcessOrder() Fetch multiple ProcessOrder entities.
ProcessOrderComponentFluentHelper	getAllProcessOrderComponent() Fetch multiple ProcessOrderComponent entities.
ProcessOrderItemFluentHelper	getAllProcessOrderItem() Fetch multiple ProcessOrderItem entities.
ProcessOrderOperationFluentHelper	getAllProcessOrderOperation() Fetch multiple ProcessOrderOperation entities.
ProcessOrderStatusFluentHelper	getAllProcessOrderStatus() Fetch multiple ProcessOrderStatus entities.
ProcessOrderByKeyFluentHelper	getProcessOrderByKey(String processOrder) Fetch a single ProcessOrder entity using key fields.
ProcessOrderComponentByKeyFluentHelper	getProcessOrderComponentByKey(String reservation, String reservationItem) Fetch a single ProcessOrderComponent entity using key fields.
ProcessOrderItemByKeyFluentHelper	getProcessOrderItemByKey(String manufacturingOrder, String manufacturingOrderItem) Fetch a single ProcessOrderItem entity using key fields.
ProcessOrderOperationByKeyFluentHelper	getProcessOrderOperationByKey(String orderInternalBillOfOperations, String orderIntBillOfOperationsItem) Fetch a single ProcessOrderOperation entity using key fields.
ProcessOrderStatusByKeyFluentHelper	getProcessOrderStatusByKey(String manufacturingOrder, String statusCode) Fetch a single ProcessOrderStatus entity using key fields.
ProcessOrderService	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.s4hana.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
ProcessOrderService 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.

getAllProcessOrder

@Nonnull
ProcessOrderFluentHelper getAllProcessOrder()

Fetch multiple ProcessOrder entities.

Returns:

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

getProcessOrderByKey

@Nonnull
ProcessOrderByKeyFluentHelper getProcessOrderByKey(String processOrder)

Fetch a single ProcessOrder entity using key fields.

Parameters:

processOrder - Manufacturing Order ID

Constraints: Not nullable, Maximum length: 12

Returns:

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

getAllProcessOrderComponent

@Nonnull
ProcessOrderComponentFluentHelper getAllProcessOrderComponent()

Fetch multiple ProcessOrderComponent entities.

Returns:

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

getProcessOrderComponentByKey

@Nonnull
ProcessOrderComponentByKeyFluentHelper getProcessOrderComponentByKey(String reservation,
                                                                              String reservationItem)

Fetch a single ProcessOrderComponent 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 ProcessOrderComponent 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.

getAllProcessOrderItem

@Nonnull
ProcessOrderItemFluentHelper getAllProcessOrderItem()

Fetch multiple ProcessOrderItem entities.

Returns:

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

getProcessOrderItemByKey

@Nonnull
ProcessOrderItemByKeyFluentHelper getProcessOrderItemByKey(String manufacturingOrder,
                                                                    String manufacturingOrderItem)

Fetch a single ProcessOrderItem 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 ProcessOrderItem 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.

getAllProcessOrderOperation

@Nonnull
ProcessOrderOperationFluentHelper getAllProcessOrderOperation()

Fetch multiple ProcessOrderOperation entities.

Returns:

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

getProcessOrderOperationByKey

@Nonnull
ProcessOrderOperationByKeyFluentHelper getProcessOrderOperationByKey(String orderInternalBillOfOperations,
                                                                              String orderIntBillOfOperationsItem)

Fetch a single ProcessOrderOperation 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 ProcessOrderOperation 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.

getAllProcessOrderStatus

@Nonnull
ProcessOrderStatusFluentHelper getAllProcessOrderStatus()

Fetch multiple ProcessOrderStatus entities.

Returns:

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

getProcessOrderStatusByKey

@Nonnull
ProcessOrderStatusByKeyFluentHelper getProcessOrderStatusByKey(String manufacturingOrder,
                                                                        String statusCode)

Fetch a single ProcessOrderStatus 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 ProcessOrderStatus 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.