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

Interface ProcessOrderService

All Superinterfaces:

BatchService<ProcessOrderServiceBatch>

All Known Implementing Classes:

DefaultProcessOrderService

Deprecated.

The service and all its related classes are deprecated as of release 2008 (Aug 2020).

@Deprecated
public interface ProcessOrderService
extends BatchService<ProcessOrderServiceBatch>

In addition to create, read, and update, you can also release process orders and operations. This service also enables you to schedule process order operations, technically complete and close process orders as well as set the deletion flag and deletion indicator.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PROCESS_ORDERS
API Version:	1
Communication Scenario:	Manufacturing Execution - Order and Confirmation Integration (SAP_COM_0522), Production Planning Integration (SAP_COM_0104)
Scope Items:	Third-Party Shop Floor Execution - Process Industry (3W3), Third-Party Shop Floor Execution - Discrete Industry (3W4), 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:	ProcessOrder

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH Deprecated. 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
CloseOrderFluentHelper	closeOrder(String manufacturingOrder) Deprecated. Creates a fluent helper for the CloseOrder OData function import.
ConvertPlndOrderFluentHelper	convertPlndOrder(String plannedOrder, String manufacturingOrderType, String manufacturingOrder) Deprecated. Creates a fluent helper for the ConvertPlndOrder OData function import.
FunctionMessageCreateFluentHelper	createFunctionMessage(FunctionMessage functionMessage) Deprecated. Create a new FunctionMessage entity and save it to the S/4HANA system.
ProcessOrderCreateFluentHelper	createProcessOrder(ProcessOrder processOrder) Deprecated. Create a new ProcessOrder entity and save it to the S/4HANA system.
FunctionMessageDeleteFluentHelper	deleteFunctionMessage(FunctionMessage functionMessage) Deprecated. Deletes an existing FunctionMessage entity in the S/4HANA system.
DeletionFlagOrderFluentHelper	deletionFlagOrder(String manufacturingOrder) Deprecated. Creates a fluent helper for the DeletionFlagOrder OData function import.
DeletionIndOrderFluentHelper	deletionIndOrder(String manufacturingOrder) Deprecated. Creates a fluent helper for the DeletionIndOrder OData function import.
DiscardOrderFluentHelper	discardOrder(String manufacturingOrder) Deprecated. Creates a fluent helper for the DiscardOrder OData function import.
FunctionMessageFluentHelper	getAllFunctionMessage() Deprecated. Fetch multiple FunctionMessage entities.
ProcessOrderFluentHelper	getAllProcessOrder() Deprecated. Fetch multiple ProcessOrder entities.
ProcessOrderComponentFluentHelper	getAllProcessOrderComponent() Deprecated. Fetch multiple ProcessOrderComponent entities.
ProcessOrderItemFluentHelper	getAllProcessOrderItem() Deprecated. Fetch multiple ProcessOrderItem entities.
ProcessOrderOperationFluentHelper	getAllProcessOrderOperation() Deprecated. Fetch multiple ProcessOrderOperation entities.
ProcessOrderStatusFluentHelper	getAllProcessOrderStatus() Deprecated. Fetch multiple ProcessOrderStatus entities.
FunctionMessageByKeyFluentHelper	getFunctionMessageByKey(String message) Deprecated. Fetch a single FunctionMessage entity using key fields.
ProcessOrderByKeyFluentHelper	getProcessOrderByKey(String processOrder) Deprecated. Fetch a single ProcessOrder entity using key fields.
ProcessOrderComponentByKeyFluentHelper	getProcessOrderComponentByKey(String reservation, String reservationItem) Deprecated. Fetch a single ProcessOrderComponent entity using key fields.
ProcessOrderItemByKeyFluentHelper	getProcessOrderItemByKey(String manufacturingOrder, String manufacturingOrderItem) Deprecated. Fetch a single ProcessOrderItem entity using key fields.
ProcessOrderOperationByKeyFluentHelper	getProcessOrderOperationByKey(String orderInternalBillOfOperations, String orderIntBillOfOperationsItem) Deprecated. Fetch a single ProcessOrderOperation entity using key fields.
ProcessOrderStatusByKeyFluentHelper	getProcessOrderStatusByKey(String manufacturingOrder, String statusCode) Deprecated. Fetch a single ProcessOrderStatus entity using key fields.
ReleaseOperationFluentHelper	releaseOperation(String manufacturingOrder, String manufacturingOrderOperation) Deprecated. Creates a fluent helper for the ReleaseOperation OData function import.
ReleaseOrderFluentHelper	releaseOrder(String manufacturingOrder) Deprecated. Creates a fluent helper for the ReleaseOrder OData function import.
ScheduleProcessOrderOperationFluentHelper	scheduleProcessOrderOperation(String manufacturingOrder, String orderInternalBillOfOperations, String orderIntBillOfOperationsItem, LocalDateTime opSchedldStartDate, LocalTime opSchedldStartTime, LocalDateTime opSchedldEndDate, LocalTime opSchedldEndTime, String opSchedulingMode, String opSchedulingStatus, String opSchedulingStrategy) Deprecated. Creates a fluent helper for the ScheduleProcessOrderOperation OData function import.
TechlyCmpltOrderFluentHelper	techlyCmpltOrder(String manufacturingOrder) Deprecated. Creates a fluent helper for the TechlyCmpltOrder OData function import.
FunctionMessageUpdateFluentHelper	updateFunctionMessage(FunctionMessage functionMessage) Deprecated. Update an existing FunctionMessage entity and save it to the S/4HANA system.
ProcessOrderUpdateFluentHelper	updateProcessOrder(ProcessOrder processOrder) Deprecated. Update an existing ProcessOrder entity and save it to the S/4HANA system.
ProcessOrderService	withServicePath(String servicePath) Deprecated. 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

Deprecated.

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)

Deprecated.

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.

getAllFunctionMessage

@Nonnull
FunctionMessageFluentHelper getAllFunctionMessage()

Deprecated.

Fetch multiple FunctionMessage entities.

Returns:

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

getFunctionMessageByKey

@Nonnull
FunctionMessageByKeyFluentHelper getFunctionMessageByKey(String message)

Deprecated.

Fetch a single FunctionMessage entity using key fields.

Parameters:

message - Message text

Constraints: Not nullable, Maximum length: 220

Returns:

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

createFunctionMessage

@Nonnull
FunctionMessageCreateFluentHelper createFunctionMessage(@Nonnull
                                                                 FunctionMessage functionMessage)

Deprecated.

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

Parameters:

functionMessage - FunctionMessage entity object that will be created in the S/4HANA system.

Returns:

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

updateFunctionMessage

@Nonnull
FunctionMessageUpdateFluentHelper updateFunctionMessage(@Nonnull
                                                                 FunctionMessage functionMessage)

Deprecated.

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

Parameters:

functionMessage - FunctionMessage entity object that will be updated in the S/4HANA system.

Returns:

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

deleteFunctionMessage

@Nonnull
FunctionMessageDeleteFluentHelper deleteFunctionMessage(@Nonnull
                                                                 FunctionMessage functionMessage)

Deprecated.

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

Parameters:

functionMessage - FunctionMessage entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllProcessOrder

@Nonnull
ProcessOrderFluentHelper getAllProcessOrder()

Deprecated.

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)

Deprecated.

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.

createProcessOrder

@Nonnull
ProcessOrderCreateFluentHelper createProcessOrder(@Nonnull
                                                           ProcessOrder processOrder)

Deprecated.

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

Parameters:

processOrder - ProcessOrder entity object that will be created in the S/4HANA system.

Returns:

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

updateProcessOrder

@Nonnull
ProcessOrderUpdateFluentHelper updateProcessOrder(@Nonnull
                                                           ProcessOrder processOrder)

Deprecated.

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

Parameters:

processOrder - ProcessOrder entity object that will be updated in the S/4HANA system.

Returns:

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

getAllProcessOrderComponent

@Nonnull
ProcessOrderComponentFluentHelper getAllProcessOrderComponent()

Deprecated.

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)

Deprecated.

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

Deprecated.

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)

Deprecated.

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()

Deprecated.

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)

Deprecated.

Fetch a single ProcessOrderOperation entity using key fields.

Parameters:

orderIntBillOfOperationsItem - Internal Identifier of an Operation or Activity

Constraints: Not nullable, Maximum length: 8

orderInternalBillOfOperations - Order Internal 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()

Deprecated.

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)

Deprecated.

Fetch a single ProcessOrderStatus entity using key fields.

Parameters:

manufacturingOrder - Key that uniquely identifies an order within a client.

Constraints: Not nullable, Maximum length: 12

statusCode - Key which informs you of the current status of an object.

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.

releaseOrder

@Nonnull
ReleaseOrderFluentHelper releaseOrder(@Nonnull
                                               String manufacturingOrder)

Deprecated.

Creates a fluent helper for the ReleaseOrder OData function import.

Parameters:

manufacturingOrder - Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: ManufacturingOrder

Returns:

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

releaseOperation

@Nonnull
ReleaseOperationFluentHelper releaseOperation(@Nonnull
                                                       String manufacturingOrder,
                                                       @Nonnull
                                                       String manufacturingOrderOperation)

Deprecated.

Creates a fluent helper for the ReleaseOperation OData function import.

Parameters:

manufacturingOrderOperation - Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: ManufacturingOrderOperation

manufacturingOrder - Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: ManufacturingOrder

Returns:

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

techlyCmpltOrder

@Nonnull
TechlyCmpltOrderFluentHelper techlyCmpltOrder(@Nonnull
                                                       String manufacturingOrder)

Deprecated.

Creates a fluent helper for the TechlyCmpltOrder OData function import.

Parameters:

manufacturingOrder - Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: ManufacturingOrder

Returns:

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

closeOrder

@Nonnull
CloseOrderFluentHelper closeOrder(@Nonnull
                                           String manufacturingOrder)

Deprecated.

Creates a fluent helper for the CloseOrder OData function import.

Parameters:

manufacturingOrder - Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: ManufacturingOrder

Returns:

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

deletionFlagOrder

@Nonnull
DeletionFlagOrderFluentHelper deletionFlagOrder(@Nonnull
                                                         String manufacturingOrder)

Deprecated.

Creates a fluent helper for the DeletionFlagOrder OData function import.

Parameters:

manufacturingOrder - Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: ManufacturingOrder

Returns:

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

deletionIndOrder

@Nonnull
DeletionIndOrderFluentHelper deletionIndOrder(@Nonnull
                                                       String manufacturingOrder)

Deprecated.

Creates a fluent helper for the DeletionIndOrder OData function import.

Parameters:

manufacturingOrder - Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: ManufacturingOrder

Returns:

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

discardOrder

@Nonnull
DiscardOrderFluentHelper discardOrder(@Nonnull
                                               String manufacturingOrder)

Deprecated.

Creates a fluent helper for the DiscardOrder OData function import.

Parameters:

manufacturingOrder - Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: ManufacturingOrder

Returns:

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

convertPlndOrder

@Nonnull
ConvertPlndOrderFluentHelper convertPlndOrder(@Nonnull
                                                       String plannedOrder,
                                                       @Nullable
                                                       String manufacturingOrderType,
                                                       @Nullable
                                                       String manufacturingOrder)

Deprecated.

Creates a fluent helper for the ConvertPlndOrder OData function import.

Parameters:

plannedOrder - Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: PlannedOrder

manufacturingOrderType - Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: ManufacturingOrderType

manufacturingOrder - Constraints: Nullable, Maximum length: 12

Original parameter name from the Odata EDM: ManufacturingOrder

Returns:

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

scheduleProcessOrderOperation

@Nonnull
ScheduleProcessOrderOperationFluentHelper scheduleProcessOrderOperation(@Nonnull
                                                                                 String manufacturingOrder,
                                                                                 @Nonnull
                                                                                 String orderInternalBillOfOperations,
                                                                                 @Nonnull
                                                                                 String orderIntBillOfOperationsItem,
                                                                                 @Nullable
                                                                                 LocalDateTime opSchedldStartDate,
                                                                                 @Nullable
                                                                                 LocalTime opSchedldStartTime,
                                                                                 @Nullable
                                                                                 LocalDateTime opSchedldEndDate,
                                                                                 @Nullable
                                                                                 LocalTime opSchedldEndTime,
                                                                                 @Nonnull
                                                                                 String opSchedulingMode,
                                                                                 @Nullable
                                                                                 String opSchedulingStatus,
                                                                                 @Nonnull
                                                                                 String opSchedulingStrategy)

Deprecated.

Creates a fluent helper for the ScheduleProcessOrderOperation OData function import.

Parameters:

orderIntBillOfOperationsItem - Operation Internal ID

Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: OrderIntBillOfOperationsItem

opSchedldStartDate - Execution Start Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: OpSchedldStartDate

opSchedulingStrategy - Component of the Version Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: OpSchedulingStrategy

orderInternalBillOfOperations - Order Internal ID

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: OrderInternalBillOfOperations

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

manufacturingOrder - Order

Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: ManufacturingOrder

opSchedldStartTime - Execution Start Time

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: OpSchedldStartTime

opSchedldEndDate - Execution End Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: OpSchedldEndDate

opSchedldEndTime - Execution End Time

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: OpSchedldEndTime

Returns:

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