ProductionOrderV2Service (SAP Cloud SDK

All Superinterfaces:: BatchService<ProductionOrderV2ServiceBatch>

All Known Implementing Classes:: DefaultProductionOrderV2Service

public interface ProductionOrderV2Service
extends BatchService<ProductionOrderV2ServiceBatch>

In addition to create, read, and update, you can also release production orders and operations. This service enables you to convert planned orders to production orders, schedule production order operations, and set further statuses for the order such as technically completed, closed, or discarded by MES. In addition, you can set the deletion flag, deletion indicator, and delivery completed indicator.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PRODUCTION_ORDER_2_SRV
API Version:	1
Communication Scenario:	Manufacturing Execution - Order and Confirmation Integration (SAP_COM_0522)
Scope Items:	Third-Party Shop Floor Execution - Process Industry (3W3), Third-Party Shop Floor Execution - Discrete Industry (3W4)
Authentication Methods:	Basic, x509
Business Object:	ProductionOrder

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CloseOrderFluentHelper`	`closeOrder(String manufacturingOrder)` Creates a fluent helper for the CloseOrder OData function import.
`ConvertPlndOrderFluentHelper`	`convertPlndOrder(String manufacturingOrder, String plannedOrder, String manufacturingOrderType)` Creates a fluent helper for the ConvertPlndOrder OData function import.
`ProductionOrder_2CreateFluentHelper`	`createProductionOrder_2(ProductionOrder_2 productionOrder_2)` Create a new `ProductionOrder_2` entity and save it to 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.
`DeliveryCompletedOrderFluentHelper`	`deliveryCompletedOrder(String manufacturingOrder)` Creates a fluent helper for the DeliveryCompletedOrder OData function import.
`DiscardOrderFluentHelper`	`discardOrder(String manufacturingOrder)` Creates a fluent helper for the DiscardOrder OData function import.
`ProductionOrder_2FluentHelper`	`getAllProductionOrder_2()` Fetch multiple `ProductionOrder_2` entities.
`ProductionOrderComponent_2FluentHelper`	`getAllProductionOrderComponent_2()` Fetch multiple `ProductionOrderComponent_2` entities.
`ProductionOrderItem_2FluentHelper`	`getAllProductionOrderItem_2()` Fetch multiple `ProductionOrderItem_2` entities.
`ProductionOrderOperation_2FluentHelper`	`getAllProductionOrderOperation_2()` Fetch multiple `ProductionOrderOperation_2` entities.
`ProductionOrderStatus_2FluentHelper`	`getAllProductionOrderStatus_2()` Fetch multiple `ProductionOrderStatus_2` entities.
`ProductionRsceTools_2FluentHelper`	`getAllProductionRsceTools_2()` Fetch multiple `ProductionRsceTools_2` entities.
`ProductionOrder_2ByKeyFluentHelper`	`getProductionOrder_2ByKey(String manufacturingOrder)` Fetch a single `ProductionOrder_2` entity using key fields.
`ProductionOrderComponent_2ByKeyFluentHelper`	`getProductionOrderComponent_2ByKey(String reservation, String reservationItem)` Fetch a single `ProductionOrderComponent_2` entity using key fields.
`ProductionOrderItem_2ByKeyFluentHelper`	`getProductionOrderItem_2ByKey(String manufacturingOrder, String manufacturingOrderItem)` Fetch a single `ProductionOrderItem_2` entity using key fields.
`ProductionOrderOperation_2ByKeyFluentHelper`	`getProductionOrderOperation_2ByKey(String orderInternalBillOfOperations, String orderIntBillOfOperationsItem)` Fetch a single `ProductionOrderOperation_2` entity using key fields.
`ProductionOrderStatus_2ByKeyFluentHelper`	`getProductionOrderStatus_2ByKey(String manufacturingOrder, String statusCode)` Fetch a single `ProductionOrderStatus_2` entity using key fields.
`ProductionRsceTools_2ByKeyFluentHelper`	`getProductionRsceTools_2ByKey(String orderInternalBillOfOperations, String mfgOrderOpProdnRsceToolIntID)` Fetch a single `ProductionRsceTools_2` entity using key fields.
`ReleaseOperationFluentHelper`	`releaseOperation(String manufacturingOrder, String manufacturingOrderOperation, String manufacturingOrderSequence)` Creates a fluent helper for the ReleaseOperation OData function import.
`ReleaseOrderFluentHelper`	`releaseOrder(String manufacturingOrder)` Creates a fluent helper for the ReleaseOrder OData function import.
`ScheduleProductionOrderOperationFluentHelper`	`scheduleProductionOrderOperation(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 ScheduleProductionOrderOperation OData function import.
`TechlyCmpltOrderFluentHelper`	`techlyCmpltOrder(String manufacturingOrder)` Creates a fluent helper for the TechlyCmpltOrder OData function import.
`ProductionOrder_2UpdateFluentHelper`	`updateProductionOrder_2(ProductionOrder_2 productionOrder_2)` Update an existing `ProductionOrder_2` entity and save it to the S/4HANA system.
`ProductionOrderV2Service`	`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.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
ProductionOrderV2Service 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.
  - getAllProductionOrderComponent_2
```
@Nonnull
ProductionOrderComponent_2FluentHelper getAllProductionOrderComponent_2()
```
    Fetch multiple ProductionOrderComponent_2 entities.
    
    Returns:
    
    A fluent helper to fetch multiple ProductionOrderComponent_2 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.
  - getProductionOrderComponent_2ByKey
```
@Nonnull
ProductionOrderComponent_2ByKeyFluentHelper getProductionOrderComponent_2ByKey(String reservation,
                                                                                        String reservationItem)
```
    Fetch a single ProductionOrderComponent_2 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 ProductionOrderComponent_2 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_2
```
@Nonnull
ProductionOrderItem_2FluentHelper getAllProductionOrderItem_2()
```
    Fetch multiple ProductionOrderItem_2 entities.
    
    Returns:
    
    A fluent helper to fetch multiple ProductionOrderItem_2 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.
  - getProductionOrderItem_2ByKey
```
@Nonnull
ProductionOrderItem_2ByKeyFluentHelper getProductionOrderItem_2ByKey(String manufacturingOrder,
                                                                              String manufacturingOrderItem)
```
    Fetch a single ProductionOrderItem_2 entity using key fields.
    
    Parameters:
    
    manufacturingOrderItem - Manufacturing Order Item ID
    Constraints: Not nullable, Maximum length: 4
    
    manufacturingOrder - Production Order
    Constraints: Not nullable, Maximum length: 12
    
    Returns:
    
    A fluent helper to fetch a single ProductionOrderItem_2 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_2
```
@Nonnull
ProductionOrderOperation_2FluentHelper getAllProductionOrderOperation_2()
```
    Fetch multiple ProductionOrderOperation_2 entities.
    
    Returns:
    
    A fluent helper to fetch multiple ProductionOrderOperation_2 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.
  - getProductionOrderOperation_2ByKey
```
@Nonnull
ProductionOrderOperation_2ByKeyFluentHelper getProductionOrderOperation_2ByKey(String orderInternalBillOfOperations,
                                                                                        String orderIntBillOfOperationsItem)
```
    Fetch a single ProductionOrderOperation_2 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 ProductionOrderOperation_2 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_2
```
@Nonnull
ProductionOrderStatus_2FluentHelper getAllProductionOrderStatus_2()
```
    Fetch multiple ProductionOrderStatus_2 entities.
    
    Returns:
    
    A fluent helper to fetch multiple ProductionOrderStatus_2 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.
  - getProductionOrderStatus_2ByKey
```
@Nonnull
ProductionOrderStatus_2ByKeyFluentHelper getProductionOrderStatus_2ByKey(String manufacturingOrder,
                                                                                  String statusCode)
```
    Fetch a single ProductionOrderStatus_2 entity using key fields.
    
    Parameters:
    
    manufacturingOrder - Production Order
    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 ProductionOrderStatus_2 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.
  - getAllProductionOrder_2
```
@Nonnull
ProductionOrder_2FluentHelper getAllProductionOrder_2()
```
    Fetch multiple ProductionOrder_2 entities.
    
    Returns:
    
    A fluent helper to fetch multiple ProductionOrder_2 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.
  - getProductionOrder_2ByKey
```
@Nonnull
ProductionOrder_2ByKeyFluentHelper getProductionOrder_2ByKey(String manufacturingOrder)
```
    Fetch a single ProductionOrder_2 entity using key fields.
    
    Parameters:
    
    manufacturingOrder - Production Order
    Constraints: Not nullable, Maximum length: 12
    
    Returns:
    
    A fluent helper to fetch a single ProductionOrder_2 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.
  - createProductionOrder_2
```
@Nonnull
ProductionOrder_2CreateFluentHelper createProductionOrder_2(@Nonnull
                                                                     ProductionOrder_2 productionOrder_2)
```
    Create a new ProductionOrder_2 entity and save it to the S/4HANA system.
    
    Parameters:
    
    productionOrder_2 - ProductionOrder_2 entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new ProductionOrder_2 entity. To perform execution, call the execute method on the fluent helper object.
  - updateProductionOrder_2
```
@Nonnull
ProductionOrder_2UpdateFluentHelper updateProductionOrder_2(@Nonnull
                                                                     ProductionOrder_2 productionOrder_2)
```
    Update an existing ProductionOrder_2 entity and save it to the S/4HANA system.
    
    Parameters:
    
    productionOrder_2 - ProductionOrder_2 entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing ProductionOrder_2 entity. To perform execution, call the execute method on the fluent helper object.
  - getAllProductionRsceTools_2
```
@Nonnull
ProductionRsceTools_2FluentHelper getAllProductionRsceTools_2()
```
    Fetch multiple ProductionRsceTools_2 entities.
    
    Returns:
    
    A fluent helper to fetch multiple ProductionRsceTools_2 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.
  - getProductionRsceTools_2ByKey
```
@Nonnull
ProductionRsceTools_2ByKeyFluentHelper getProductionRsceTools_2ByKey(String orderInternalBillOfOperations,
                                                                              String mfgOrderOpProdnRsceToolIntID)
```
    Fetch a single ProductionRsceTools_2 entity using key fields.
    
    Parameters:
    
    mfgOrderOpProdnRsceToolIntID - Serial counter which is used for the unique identification of production resources/tools.
    Constraints: Not nullable, Maximum length: 8
    
    orderInternalBillOfOperations - Order Internal ID
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single ProductionRsceTools_2 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(String manufacturingOrder)
```
    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(String manufacturingOrder,
                                                       String manufacturingOrderOperation,
                                                       String manufacturingOrderSequence)
```
    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
    
    manufacturingOrderSequence - Constraints: none
    Original parameter name from the Odata EDM: ManufacturingOrderSequence
    
    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(String manufacturingOrder)
```
    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(String manufacturingOrder)
```
    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(String manufacturingOrder)
```
    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(String manufacturingOrder)
```
    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(String manufacturingOrder)
```
    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(String manufacturingOrder,
                                                       String plannedOrder,
                                                       String manufacturingOrderType)
```
    Creates a fluent helper for the ConvertPlndOrder OData function import.
    
    Parameters:
    
    plannedOrder - Constraints: none
    Original parameter name from the Odata EDM: PlannedOrder
    
    manufacturingOrderType - Constraints: Nullable
    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.
  - scheduleProductionOrderOperation
```
@Nonnull
ScheduleProductionOrderOperationFluentHelper scheduleProductionOrderOperation(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 ScheduleProductionOrderOperation 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 ScheduleProductionOrderOperation OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - deliveryCompletedOrder
```
@Nonnull
DeliveryCompletedOrderFluentHelper deliveryCompletedOrder(String manufacturingOrder)
```
    Creates a fluent helper for the DeliveryCompletedOrder 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 DeliveryCompletedOrder OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

Interface ProductionOrderV2Service

Details:

Field Summary

Method Summary

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

Field Detail

DEFAULT_SERVICE_PATH

Method Detail

withServicePath

getAllProductionOrderComponent_2

getProductionOrderComponent_2ByKey

getAllProductionOrderItem_2

getProductionOrderItem_2ByKey

getAllProductionOrderOperation_2

getProductionOrderOperation_2ByKey

getAllProductionOrderStatus_2

getProductionOrderStatus_2ByKey

getAllProductionOrder_2

getProductionOrder_2ByKey

createProductionOrder_2

updateProductionOrder_2

getAllProductionRsceTools_2

getProductionRsceTools_2ByKey

releaseOrder

releaseOperation

techlyCmpltOrder

closeOrder

deletionFlagOrder

deletionIndOrder

discardOrder

convertPlndOrder

scheduleProductionOrderOperation

deliveryCompletedOrder