@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultProcessOrderService") public class DefaultProcessOrderService extends Object implements ProcessOrderService
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 API Business Hub
OData Service: | API_PROCESS_ORDERS |
API Version: | 1 |
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), Third-Party Shop Floor Execution - Process Industry (3W3), Third-Party Shop Floor Execution - Discrete Industry (3W4) |
Authentication Methods: | Basic, x509 |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultProcessOrderService()
Creates a service using
ProcessOrderService.DEFAULT_SERVICE_PATH to send the requests. |
Modifier and Type | Method and Description |
---|---|
DefaultProcessOrderServiceBatch |
batch()
Instantiate a new FluentHelper instance for a single OData batch request.
|
CloseOrderFluentHelper |
closeOrder(String manufacturingOrder)
Creates a fluent helper for the CloseOrder OData function import.
|
ConvertPlndOrderFluentHelper |
convertPlndOrder(String plannedOrder,
String manufacturingOrderType,
String manufacturingOrder)
Creates a fluent helper for the ConvertPlndOrder OData function import.
|
FunctionMessageCreateFluentHelper |
createFunctionMessage(FunctionMessage functionMessage)
Create a new
FunctionMessage entity and save it to the S/4HANA system. |
ProcessOrderCreateFluentHelper |
createProcessOrder(ProcessOrder processOrder)
Create a new
ProcessOrder
entity and save it to the S/4HANA system. |
FunctionMessageDeleteFluentHelper |
deleteFunctionMessage(FunctionMessage functionMessage)
Deletes an existing
FunctionMessage entity in the S/4HANA system. |
DeletionFlagOrderFluentHelper |
deletionFlagOrder(String manufacturingOrder)
Creates a fluent helper for the DeletionFlagOrder OData function import.
|
DeletionIndOrderFluentHelper |
deletionIndOrder(String manufacturingOrder)
Creates a fluent helper for the DeletionIndOrder OData function import.
|
DiscardOrderFluentHelper |
discardOrder(String manufacturingOrder)
Creates a fluent helper for the DiscardOrder OData function import.
|
FunctionMessageFluentHelper |
getAllFunctionMessage()
Fetch multiple
FunctionMessage entities. |
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. |
FunctionMessageByKeyFluentHelper |
getFunctionMessageByKey(String message)
Fetch a single
FunctionMessage entity using key fields. |
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. |
ReleaseOperationFluentHelper |
releaseOperation(String manufacturingOrder,
String manufacturingOrderOperation)
Creates a fluent helper for the ReleaseOperation OData function import.
|
ReleaseOrderFluentHelper |
releaseOrder(String manufacturingOrder)
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)
Creates a fluent helper for the ScheduleProcessOrderOperation OData function import.
|
TechlyCmpltOrderFluentHelper |
techlyCmpltOrder(String manufacturingOrder)
Creates a fluent helper for the TechlyCmpltOrder OData function import.
|
FunctionMessageUpdateFluentHelper |
updateFunctionMessage(FunctionMessage functionMessage)
Update an existing
FunctionMessage entity and save it to the S/4HANA system. |
ProcessOrderUpdateFluentHelper |
updateProcessOrder(ProcessOrder processOrder)
Update an existing
ProcessOrder entity and save it to the S/4HANA system. |
DefaultProcessOrderService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
public DefaultProcessOrderService()
ProcessOrderService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultProcessOrderService withServicePath(@Nonnull String servicePath)
ProcessOrderService
withServicePath
in interface ProcessOrderService
servicePath
- Service path that will override the default.@Nonnull public DefaultProcessOrderServiceBatch batch()
batch
in interface BatchService<ProcessOrderServiceBatch>
@Nonnull public FunctionMessageFluentHelper getAllFunctionMessage()
ProcessOrderService
FunctionMessage
entities.getAllFunctionMessage
in interface ProcessOrderService
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.@Nonnull public FunctionMessageByKeyFluentHelper getFunctionMessageByKey(String message)
ProcessOrderService
FunctionMessage
entity using key fields.getFunctionMessageByKey
in interface ProcessOrderService
message
- Message text
Constraints: Not nullable, Maximum length: 220
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.@Nonnull public FunctionMessageCreateFluentHelper createFunctionMessage(@Nonnull FunctionMessage functionMessage)
ProcessOrderService
FunctionMessage
entity and save it to the S/4HANA system.createFunctionMessage
in interface ProcessOrderService
functionMessage
- FunctionMessage
entity object that will be created in the S/4HANA system.FunctionMessage
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public FunctionMessageUpdateFluentHelper updateFunctionMessage(@Nonnull FunctionMessage functionMessage)
ProcessOrderService
FunctionMessage
entity and save it to the S/4HANA system.updateFunctionMessage
in interface ProcessOrderService
functionMessage
- FunctionMessage
entity object that will be updated in the S/4HANA system.FunctionMessage
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public FunctionMessageDeleteFluentHelper deleteFunctionMessage(@Nonnull FunctionMessage functionMessage)
ProcessOrderService
FunctionMessage
entity in the S/4HANA system.deleteFunctionMessage
in interface ProcessOrderService
functionMessage
- FunctionMessage
entity object that will be deleted in the S/4HANA system.FunctionMessage
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public ProcessOrderFluentHelper getAllProcessOrder()
ProcessOrderService
ProcessOrder
entities.getAllProcessOrder
in interface ProcessOrderService
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.@Nonnull public ProcessOrderByKeyFluentHelper getProcessOrderByKey(String processOrder)
ProcessOrderService
ProcessOrder
entity using key fields.getProcessOrderByKey
in interface ProcessOrderService
processOrder
- Manufacturing Order ID
Constraints: Not nullable, Maximum length: 12
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.@Nonnull public ProcessOrderCreateFluentHelper createProcessOrder(@Nonnull ProcessOrder processOrder)
ProcessOrderService
ProcessOrder
entity and save it to the S/4HANA system.createProcessOrder
in interface ProcessOrderService
processOrder
- ProcessOrder
entity object that will be created in the S/4HANA system.ProcessOrder
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public ProcessOrderUpdateFluentHelper updateProcessOrder(@Nonnull ProcessOrder processOrder)
ProcessOrderService
ProcessOrder
entity and save it to the S/4HANA system.updateProcessOrder
in interface ProcessOrderService
processOrder
- ProcessOrder
entity object that will be updated in the S/4HANA system.ProcessOrder
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public ProcessOrderComponentFluentHelper getAllProcessOrderComponent()
ProcessOrderService
ProcessOrderComponent
entities.getAllProcessOrderComponent
in interface ProcessOrderService
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.@Nonnull public ProcessOrderComponentByKeyFluentHelper getProcessOrderComponentByKey(String reservation, String reservationItem)
ProcessOrderService
ProcessOrderComponent
entity using key fields.getProcessOrderComponentByKey
in interface ProcessOrderService
reservation
- Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
reservationItem
- Reservation Item
Constraints: Not nullable, Maximum length: 4
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.@Nonnull public ProcessOrderItemFluentHelper getAllProcessOrderItem()
ProcessOrderService
ProcessOrderItem
entities.getAllProcessOrderItem
in interface ProcessOrderService
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.@Nonnull public ProcessOrderItemByKeyFluentHelper getProcessOrderItemByKey(String manufacturingOrder, String manufacturingOrderItem)
ProcessOrderService
ProcessOrderItem
entity using key fields.getProcessOrderItemByKey
in interface ProcessOrderService
manufacturingOrder
- Manufacturing Order ID
Constraints: Not nullable, Maximum length: 12
manufacturingOrderItem
- Manufacturing Order Item ID
Constraints: Not nullable, Maximum length: 4
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.@Nonnull public ProcessOrderOperationFluentHelper getAllProcessOrderOperation()
ProcessOrderService
ProcessOrderOperation
entities.getAllProcessOrderOperation
in interface ProcessOrderService
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.@Nonnull public ProcessOrderOperationByKeyFluentHelper getProcessOrderOperationByKey(String orderInternalBillOfOperations, String orderIntBillOfOperationsItem)
ProcessOrderService
ProcessOrderOperation
entity using key fields.getProcessOrderOperationByKey
in interface ProcessOrderService
orderInternalBillOfOperations
- Order Internal ID
Constraints: Not nullable, Maximum length: 10
orderIntBillOfOperationsItem
- Internal Identifier of an Operation or Activity
Constraints: Not nullable, Maximum length: 8
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.@Nonnull public ProcessOrderStatusFluentHelper getAllProcessOrderStatus()
ProcessOrderService
ProcessOrderStatus
entities.getAllProcessOrderStatus
in interface ProcessOrderService
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.@Nonnull public ProcessOrderStatusByKeyFluentHelper getProcessOrderStatusByKey(String manufacturingOrder, String statusCode)
ProcessOrderService
ProcessOrderStatus
entity using key fields.getProcessOrderStatusByKey
in interface ProcessOrderService
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
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.@Nonnull public ReleaseOrderFluentHelper releaseOrder(String manufacturingOrder)
ProcessOrderService
Creates a fluent helper for the ReleaseOrder OData function import.
releaseOrder
in interface ProcessOrderService
manufacturingOrder
- Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
execute
method on the fluent helper object.@Nonnull public ReleaseOperationFluentHelper releaseOperation(String manufacturingOrder, String manufacturingOrderOperation)
ProcessOrderService
Creates a fluent helper for the ReleaseOperation OData function import.
releaseOperation
in interface ProcessOrderService
manufacturingOrder
- Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
manufacturingOrderOperation
- Constraints: Not nullable, Maximum length: 4
Original parameter name from the Odata EDM: ManufacturingOrderOperation
execute
method on the fluent helper object.@Nonnull public TechlyCmpltOrderFluentHelper techlyCmpltOrder(String manufacturingOrder)
ProcessOrderService
Creates a fluent helper for the TechlyCmpltOrder OData function import.
techlyCmpltOrder
in interface ProcessOrderService
manufacturingOrder
- Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
execute
method on the fluent helper object.@Nonnull public CloseOrderFluentHelper closeOrder(String manufacturingOrder)
ProcessOrderService
Creates a fluent helper for the CloseOrder OData function import.
closeOrder
in interface ProcessOrderService
manufacturingOrder
- Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
execute
method on the fluent helper object.@Nonnull public DeletionFlagOrderFluentHelper deletionFlagOrder(String manufacturingOrder)
ProcessOrderService
Creates a fluent helper for the DeletionFlagOrder OData function import.
deletionFlagOrder
in interface ProcessOrderService
manufacturingOrder
- Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
execute
method on the fluent helper object.@Nonnull public DeletionIndOrderFluentHelper deletionIndOrder(String manufacturingOrder)
ProcessOrderService
Creates a fluent helper for the DeletionIndOrder OData function import.
deletionIndOrder
in interface ProcessOrderService
manufacturingOrder
- Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
execute
method on the fluent helper object.@Nonnull public DiscardOrderFluentHelper discardOrder(String manufacturingOrder)
ProcessOrderService
Creates a fluent helper for the DiscardOrder OData function import.
discardOrder
in interface ProcessOrderService
manufacturingOrder
- Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
execute
method on the fluent helper object.@Nonnull public ConvertPlndOrderFluentHelper convertPlndOrder(String plannedOrder, String manufacturingOrderType, String manufacturingOrder)
ProcessOrderService
Creates a fluent helper for the ConvertPlndOrder OData function import.
convertPlndOrder
in interface ProcessOrderService
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
execute
method on the fluent helper object.@Nonnull public ScheduleProcessOrderOperationFluentHelper scheduleProcessOrderOperation(String manufacturingOrder, String orderInternalBillOfOperations, String orderIntBillOfOperationsItem, LocalDateTime opSchedldStartDate, LocalTime opSchedldStartTime, LocalDateTime opSchedldEndDate, LocalTime opSchedldEndTime, String opSchedulingMode, String opSchedulingStatus, String opSchedulingStrategy)
ProcessOrderService
Creates a fluent helper for the ScheduleProcessOrderOperation OData function import.
scheduleProcessOrderOperation
in interface ProcessOrderService
manufacturingOrder
- Order
Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
orderInternalBillOfOperations
- Order Internal ID
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: OrderInternalBillOfOperations
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
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
opSchedulingMode
- Scheduling type
Constraints: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: OpSchedulingMode
opSchedulingStatus
- Status
Constraints: Nullable, Maximum length: 4
Original parameter name from the Odata EDM: OpSchedulingStatus
opSchedulingStrategy
- Component of the Version Number
Constraints: Not nullable, Maximum length: 4
Original parameter name from the Odata EDM: OpSchedulingStrategy
execute
method on the fluent helper object.Copyright © 2020 SAP SE. All rights reserved.