Interface ProcessOrderService
- All Superinterfaces:
BatchService<ProcessOrderServiceBatch>
- All Known Implementing Classes:
DefaultProcessOrderService
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.
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | API_PROCESS_ORDERS |
| API Version: | 1.0.0 |
| Minimum ERP Version: | 2208 |
| Communication Scenario: | Production Planning Integration(SAP_COM_0104), Manufacturing Execution - Order and Confirmation Integration(SAP_COM_0522) |
| Scope Items: | Make-to-Stock Production - Discrete Manufacturing(BJ5), Make-to-Stock - Process Manufacturing Based on Process Order(BJ8), Material Requirements Planning(J44), Material Requirements Planning(O44), Third-Party Shop Floor Execution - Process Industry(3W3), Third-Party Shop Floor Execution - Discrete Industry(3W4) |
| Business Object: | Process Order |
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint. -
Method Summary
Modifier and TypeMethodDescriptioncloseOrder(String manufacturingOrder) Deprecated.Creates a fluent helper for the CloseOrder OData function import.convertPlndOrder(String plannedOrder, String manufacturingOrderType, String manufacturingOrder) Deprecated.Creates a fluent helper for the ConvertPlndOrder OData function import.createFunctionMessage(FunctionMessage functionMessage) Deprecated.Create a newFunctionMessageentity and save it to the S/4HANA system.createProcessOrder(ProcessOrder processOrder) Deprecated.Create a newProcessOrderentity and save it to the S/4HANA system.deleteFunctionMessage(FunctionMessage functionMessage) Deprecated.Deletes an existingFunctionMessageentity in the S/4HANA system.deletionFlagOrder(String manufacturingOrder) Deprecated.Creates a fluent helper for the DeletionFlagOrder OData function import.deletionIndOrder(String manufacturingOrder) Deprecated.Creates a fluent helper for the DeletionIndOrder OData function import.discardOrder(String manufacturingOrder) Deprecated.Creates a fluent helper for the DiscardOrder OData function import.Deprecated.Fetch multipleFunctionMessageentities.Deprecated.Fetch multipleProcessOrderentities.Deprecated.Fetch multipleProcessOrderComponententities.Deprecated.Fetch multipleProcessOrderItementities.Deprecated.Fetch multipleProcessOrderOperationentities.Deprecated.Fetch multipleProcessOrderStatusentities.getFunctionMessageByKey(String message) Deprecated.Fetch a singleFunctionMessageentity using key fields.getProcessOrderByKey(String processOrder) Deprecated.Fetch a singleProcessOrderentity using key fields.getProcessOrderComponentByKey(String reservation, String reservationItem) Deprecated.Fetch a singleProcessOrderComponententity using key fields.getProcessOrderItemByKey(String manufacturingOrder, String manufacturingOrderItem) Deprecated.Fetch a singleProcessOrderItementity using key fields.getProcessOrderOperationByKey(String orderInternalBillOfOperations, String orderIntBillOfOperationsItem) Deprecated.Fetch a singleProcessOrderOperationentity using key fields.getProcessOrderStatusByKey(String manufacturingOrder, String statusCode) Deprecated.Fetch a singleProcessOrderStatusentity using key fields.releaseOperation(String manufacturingOrder, String manufacturingOrderOperation) Deprecated.Creates a fluent helper for the ReleaseOperation OData function import.releaseOrder(String manufacturingOrder) Deprecated.Creates a fluent helper for the ReleaseOrder OData function import.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.techlyCmpltOrder(String manufacturingOrder) Deprecated.Creates a fluent helper for the TechlyCmpltOrder OData function import.updateFunctionMessage(FunctionMessage functionMessage) Deprecated.Update an existingFunctionMessageentity and save it to the S/4HANA system.updateProcessOrder(ProcessOrder processOrder) Deprecated.Update an existingProcessOrderentity and save it to the S/4HANA system.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 Details
-
DEFAULT_SERVICE_PATH
Deprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint.- See Also:
-
-
Method Details
-
withServicePath
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
Deprecated.Fetch multipleFunctionMessageentities.- Returns:
- A fluent helper to fetch multiple
FunctionMessageentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getFunctionMessageByKey
Deprecated.Fetch a singleFunctionMessageentity using key fields.- Parameters:
message- Message textConstraints: Not nullable, Maximum length: 220
- Returns:
- A fluent helper to fetch a single
FunctionMessageentity 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 theexecutemethod on the fluent helper object.
-
createFunctionMessage
@Nonnull FunctionMessageCreateFluentHelper createFunctionMessage(@Nonnull FunctionMessage functionMessage) Deprecated.Create a newFunctionMessageentity and save it to the S/4HANA system.- Parameters:
functionMessage-FunctionMessageentity object that will be created in the S/4HANA system.- Returns:
- A fluent helper to create a new
FunctionMessageentity. To perform execution, call theexecutemethod on the fluent helper object.
-
updateFunctionMessage
@Nonnull FunctionMessageUpdateFluentHelper updateFunctionMessage(@Nonnull FunctionMessage functionMessage) Deprecated.Update an existingFunctionMessageentity and save it to the S/4HANA system.- Parameters:
functionMessage-FunctionMessageentity object that will be updated in the S/4HANA system.- Returns:
- A fluent helper to update an existing
FunctionMessageentity. To perform execution, call theexecutemethod on the fluent helper object.
-
deleteFunctionMessage
@Nonnull FunctionMessageDeleteFluentHelper deleteFunctionMessage(@Nonnull FunctionMessage functionMessage) Deprecated.Deletes an existingFunctionMessageentity in the S/4HANA system.- Parameters:
functionMessage-FunctionMessageentity object that will be deleted in the S/4HANA system.- Returns:
- A fluent helper to delete an existing
FunctionMessageentity. To perform execution, call theexecutemethod on the fluent helper object.
-
getAllProcessOrder
Deprecated.Fetch multipleProcessOrderentities.- Returns:
- A fluent helper to fetch multiple
ProcessOrderentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getProcessOrderByKey
Deprecated.Fetch a singleProcessOrderentity using key fields.- Parameters:
processOrder- Manufacturing Order IDConstraints: Not nullable, Maximum length: 12
- Returns:
- A fluent helper to fetch a single
ProcessOrderentity 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 theexecutemethod on the fluent helper object.
-
createProcessOrder
Deprecated.Create a newProcessOrderentity and save it to the S/4HANA system.- Parameters:
processOrder-ProcessOrderentity object that will be created in the S/4HANA system.- Returns:
- A fluent helper to create a new
ProcessOrderentity. To perform execution, call theexecutemethod on the fluent helper object.
-
updateProcessOrder
Deprecated.Update an existingProcessOrderentity and save it to the S/4HANA system.- Parameters:
processOrder-ProcessOrderentity object that will be updated in the S/4HANA system.- Returns:
- A fluent helper to update an existing
ProcessOrderentity. To perform execution, call theexecutemethod on the fluent helper object.
-
getAllProcessOrderComponent
Deprecated.Fetch multipleProcessOrderComponententities.- Returns:
- A fluent helper to fetch multiple
ProcessOrderComponententities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getProcessOrderComponentByKey
@Nonnull ProcessOrderComponentByKeyFluentHelper getProcessOrderComponentByKey(String reservation, String reservationItem) Deprecated.Fetch a singleProcessOrderComponententity using key fields.- Parameters:
reservationItem- Reservation ItemConstraints: Not nullable, Maximum length: 4
reservation- Number of reservation/dependent requirementsConstraints: Not nullable, Maximum length: 10
- Returns:
- A fluent helper to fetch a single
ProcessOrderComponententity 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 theexecutemethod on the fluent helper object.
-
getAllProcessOrderItem
Deprecated.Fetch multipleProcessOrderItementities.- Returns:
- A fluent helper to fetch multiple
ProcessOrderItementities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getProcessOrderItemByKey
@Nonnull ProcessOrderItemByKeyFluentHelper getProcessOrderItemByKey(String manufacturingOrder, String manufacturingOrderItem) Deprecated.Fetch a singleProcessOrderItementity using key fields.- Parameters:
manufacturingOrderItem- Manufacturing Order Item IDConstraints: Not nullable, Maximum length: 4
manufacturingOrder- Manufacturing Order IDConstraints: Not nullable, Maximum length: 12
- Returns:
- A fluent helper to fetch a single
ProcessOrderItementity 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 theexecutemethod on the fluent helper object.
-
getAllProcessOrderOperation
Deprecated.Fetch multipleProcessOrderOperationentities.- Returns:
- A fluent helper to fetch multiple
ProcessOrderOperationentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getProcessOrderOperationByKey
@Nonnull ProcessOrderOperationByKeyFluentHelper getProcessOrderOperationByKey(String orderInternalBillOfOperations, String orderIntBillOfOperationsItem) Deprecated.Fetch a singleProcessOrderOperationentity using key fields.- Parameters:
orderIntBillOfOperationsItem- Internal Identifier of an Operation or ActivityConstraints: Not nullable, Maximum length: 8
orderInternalBillOfOperations- Order Internal IDConstraints: Not nullable, Maximum length: 10
- Returns:
- A fluent helper to fetch a single
ProcessOrderOperationentity 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 theexecutemethod on the fluent helper object.
-
getAllProcessOrderStatus
Deprecated.Fetch multipleProcessOrderStatusentities.- Returns:
- A fluent helper to fetch multiple
ProcessOrderStatusentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getProcessOrderStatusByKey
@Nonnull ProcessOrderStatusByKeyFluentHelper getProcessOrderStatusByKey(String manufacturingOrder, String statusCode) Deprecated.Fetch a singleProcessOrderStatusentity using key fields.- Parameters:
manufacturingOrder- Order NumberConstraints: Not nullable, Maximum length: 12
statusCode- Object statusConstraints: Not nullable, Maximum length: 5
- Returns:
- A fluent helper to fetch a single
ProcessOrderStatusentity 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 theexecutemethod on the fluent helper object.
-
releaseOrder
Deprecated.Creates a fluent helper for the ReleaseOrder OData function import.
- Parameters:
manufacturingOrder- Constraints: Not nullable, Maximum length: 12Original 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
executemethod 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: 4Original parameter name from the Odata EDM: ManufacturingOrderOperation
manufacturingOrder- Constraints: Not nullable, Maximum length: 12Original 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
executemethod on the fluent helper object.
-
techlyCmpltOrder
Deprecated.Creates a fluent helper for the TechlyCmpltOrder OData function import.
- Parameters:
manufacturingOrder- Constraints: Not nullable, Maximum length: 12Original 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
executemethod on the fluent helper object.
-
closeOrder
Deprecated.Creates a fluent helper for the CloseOrder OData function import.
- Parameters:
manufacturingOrder- Constraints: Not nullable, Maximum length: 12Original 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
executemethod on the fluent helper object.
-
deletionFlagOrder
Deprecated.Creates a fluent helper for the DeletionFlagOrder OData function import.
- Parameters:
manufacturingOrder- Constraints: Not nullable, Maximum length: 12Original 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
executemethod on the fluent helper object.
-
deletionIndOrder
Deprecated.Creates a fluent helper for the DeletionIndOrder OData function import.
- Parameters:
manufacturingOrder- Constraints: Not nullable, Maximum length: 12Original 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
executemethod on the fluent helper object.
-
discardOrder
Deprecated.Creates a fluent helper for the DiscardOrder OData function import.
- Parameters:
manufacturingOrder- Constraints: Not nullable, Maximum length: 12Original 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
executemethod 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: 10Original parameter name from the Odata EDM: PlannedOrder
manufacturingOrderType- Constraints: Nullable, Maximum length: 4Original parameter name from the Odata EDM: ManufacturingOrderType
manufacturingOrder- Constraints: Nullable, Maximum length: 12Original 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
executemethod 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 IDConstraints: Not nullable, Maximum length: 8
Original parameter name from the Odata EDM: OrderIntBillOfOperationsItem
opSchedldStartDate- Execution Start DateConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: OpSchedldStartDate
opSchedulingStrategy- Component of the Version NumberConstraints: Not nullable, Maximum length: 4
Original parameter name from the Odata EDM: OpSchedulingStrategy
orderInternalBillOfOperations- Order Internal IDConstraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: OrderInternalBillOfOperations
opSchedulingStatus- StatusConstraints: Nullable, Maximum length: 4
Original parameter name from the Odata EDM: OpSchedulingStatus
opSchedulingMode- Scheduling typeConstraints: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: OpSchedulingMode
manufacturingOrder- OrderConstraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
opSchedldStartTime- Execution Start TimeConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: OpSchedldStartTime
opSchedldEndDate- Execution End DateConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: OpSchedldEndDate
opSchedldEndTime- Execution End TimeConstraints: 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
executemethod on the fluent helper object.
-