DefaultPlannedOrderService (SAP Cloud SDK

java.lang.Object
- com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultPlannedOrderService

All Implemented Interfaces:: BatchService<PlannedOrderServiceBatch>, PlannedOrderService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultPlannedOrderService")
public class DefaultPlannedOrderService
extends Object
implements PlannedOrderService

In addition to executing the operations on planned orders, you can also read, create, change, and delete components belonging to the orders.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PLANNED_ORDERS
API Version:	1
Communication Scenario:	Production Planning Integration (SAP_COM_0104)
Scope Items:	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

Field Summary
- Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.PlannedOrderService
  DEFAULT_SERVICE_PATH

Constructor Summary

Constructors
Constructor and Description

DefaultPlannedOrderService()
Creates a service using PlannedOrderService.DEFAULT_SERVICE_PATH to send the requests.

Constructors
Constructor and Description
`DefaultPlannedOrderService()` Creates a service using `PlannedOrderService.DEFAULT_SERVICE_PATH` to send the requests.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DefaultPlannedOrderServiceBatch`	`batch()` Instantiate a new FluentHelper instance for a single OData batch request.
`PlannedOrderCreateFluentHelper`	`createPlannedOrder(PlannedOrder plannedOrder)` Create a new `PlannedOrder` entity and save it to the S/4HANA system.
`PlannedOrderComponentCreateFluentHelper`	`createPlannedOrderComponent(PlannedOrderComponent plannedOrderComponent)` Create a new `PlannedOrderComponent` entity and save it to the S/4HANA system.
`PlannedOrderDeleteFluentHelper`	`deletePlannedOrder(PlannedOrder plannedOrder)` Deletes an existing `PlannedOrder` entity in the S/4HANA system.
`PlannedOrderComponentDeleteFluentHelper`	`deletePlannedOrderComponent(PlannedOrderComponent plannedOrderComponent)` Deletes an existing `PlannedOrderComponent` entity in the S/4HANA system.
`PlannedOrderFluentHelper`	`getAllPlannedOrder()` Fetch multiple `PlannedOrder` entities.
`PlannedOrderCapacityFluentHelper`	`getAllPlannedOrderCapacity()` Fetch multiple `PlannedOrderCapacity` entities.
`PlannedOrderComponentFluentHelper`	`getAllPlannedOrderComponent()` Fetch multiple `PlannedOrderComponent` entities.
`PlannedOrderByKeyFluentHelper`	`getPlannedOrderByKey(String plannedOrder)` Fetch a single `PlannedOrder` entity using key fields.
`PlannedOrderCapacityByKeyFluentHelper`	`getPlannedOrderCapacityByKey(String capacityRequirement, String capacityRequirementItem, String capacityRqmtItemCapacity)` Fetch a single `PlannedOrderCapacity` entity using key fields.
`PlannedOrderComponentByKeyFluentHelper`	`getPlannedOrderComponentByKey(String reservation, String reservationItem)` Fetch a single `PlannedOrderComponent` entity using key fields.
`PlannedOrderScheduleFluentHelper`	`plannedOrderSchedule(String plannedOrder)` Creates a fluent helper for the PlannedOrderSchedule OData function import.
`PlannedOrderUpdateFluentHelper`	`updatePlannedOrder(PlannedOrder plannedOrder)` Update an existing `PlannedOrder` entity and save it to the S/4HANA system.
`PlannedOrderComponentUpdateFluentHelper`	`updatePlannedOrderComponent(PlannedOrderComponent plannedOrderComponent)` Update an existing `PlannedOrderComponent` entity and save it to the S/4HANA system.
`DefaultPlannedOrderService`	`withServicePath(String servicePath)` Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultPlannedOrderService
```
public DefaultPlannedOrderService()
```
    Creates a service using PlannedOrderService.DEFAULT_SERVICE_PATH to send the requests.
- Method Detail
  - withServicePath
```
@Nonnull
public DefaultPlannedOrderService withServicePath(@Nonnull
                                                           String servicePath)
```
    Description copied from interface: PlannedOrderService
    
    Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.
    
    Specified by:
    
    withServicePath in interface PlannedOrderService
    
    Parameters:
    
    servicePath - Service path that will override the default.
    
    Returns:
    
    A new service instance with the specified service path.
  - batch
```
@Nonnull
public DefaultPlannedOrderServiceBatch batch()
```
    Instantiate a new FluentHelper instance for a single OData batch request.
    
    Specified by:
    
    batch in interface BatchService<PlannedOrderServiceBatch>
    
    Returns:
    
    A new instance of an OData batch request associated with the service object.
  - getAllPlannedOrder
```
@Nonnull
public PlannedOrderFluentHelper getAllPlannedOrder()
```
    Description copied from interface: PlannedOrderService
    
    Fetch multiple PlannedOrder entities.
    
    Specified by:
    
    getAllPlannedOrder in interface PlannedOrderService
    
    Returns:
    
    A fluent helper to fetch multiple PlannedOrder 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.
  - getPlannedOrderByKey
```
@Nonnull
public PlannedOrderByKeyFluentHelper getPlannedOrderByKey(String plannedOrder)
```
    Description copied from interface: PlannedOrderService
    
    Fetch a single PlannedOrder entity using key fields.
    
    Specified by:
    
    getPlannedOrderByKey in interface PlannedOrderService
    
    Parameters:
    
    plannedOrder - Identifiziert den Planauftrag zu einem Material eindeutig.
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single PlannedOrder 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.
  - createPlannedOrder
```
@Nonnull
public PlannedOrderCreateFluentHelper createPlannedOrder(@Nonnull
                                                                  PlannedOrder plannedOrder)
```
    Description copied from interface: PlannedOrderService
    
    Create a new PlannedOrder entity and save it to the S/4HANA system.
    
    Specified by:
    
    createPlannedOrder in interface PlannedOrderService
    
    Parameters:
    
    plannedOrder - PlannedOrder entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new PlannedOrder entity. To perform execution, call the execute method on the fluent helper object.
  - updatePlannedOrder
```
@Nonnull
public PlannedOrderUpdateFluentHelper updatePlannedOrder(@Nonnull
                                                                  PlannedOrder plannedOrder)
```
    Description copied from interface: PlannedOrderService
    
    Update an existing PlannedOrder entity and save it to the S/4HANA system.
    
    Specified by:
    
    updatePlannedOrder in interface PlannedOrderService
    
    Parameters:
    
    plannedOrder - PlannedOrder entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing PlannedOrder entity. To perform execution, call the execute method on the fluent helper object.
  - deletePlannedOrder
```
@Nonnull
public PlannedOrderDeleteFluentHelper deletePlannedOrder(@Nonnull
                                                                  PlannedOrder plannedOrder)
```
    Description copied from interface: PlannedOrderService
    
    Deletes an existing PlannedOrder entity in the S/4HANA system.
    
    Specified by:
    
    deletePlannedOrder in interface PlannedOrderService
    
    Parameters:
    
    plannedOrder - PlannedOrder entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing PlannedOrder entity. To perform execution, call the execute method on the fluent helper object.
  - getAllPlannedOrderCapacity
```
@Nonnull
public PlannedOrderCapacityFluentHelper getAllPlannedOrderCapacity()
```
    Description copied from interface: PlannedOrderService
    
    Fetch multiple PlannedOrderCapacity entities.
    
    Specified by:
    
    getAllPlannedOrderCapacity in interface PlannedOrderService
    
    Returns:
    
    A fluent helper to fetch multiple PlannedOrderCapacity 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.
  - getPlannedOrderCapacityByKey
```
@Nonnull
public PlannedOrderCapacityByKeyFluentHelper getPlannedOrderCapacityByKey(String capacityRequirement,
                                                                                   String capacityRequirementItem,
                                                                                   String capacityRqmtItemCapacity)
```
    Description copied from interface: PlannedOrderService
    
    Fetch a single PlannedOrderCapacity entity using key fields.
    
    Specified by:
    
    getPlannedOrderCapacityByKey in interface PlannedOrderService
    
    Parameters:
    
    capacityRequirement - ID des Kapazitätsbedarfssatzes
    Constraints: Not nullable, Maximum length: 12
    
    capacityRequirementItem - Kapazitätsbedarfsposition
    Constraints: Not nullable, Maximum length: 8
    
    capacityRqmtItemCapacity - Einzelkapazität einer Kapazitätsbedarfsposition
    Constraints: Not nullable, Maximum length: 4
    
    Returns:
    
    A fluent helper to fetch a single PlannedOrderCapacity 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.
  - getAllPlannedOrderComponent
```
@Nonnull
public PlannedOrderComponentFluentHelper getAllPlannedOrderComponent()
```
    Description copied from interface: PlannedOrderService
    
    Fetch multiple PlannedOrderComponent entities.
    
    Specified by:
    
    getAllPlannedOrderComponent in interface PlannedOrderService
    
    Returns:
    
    A fluent helper to fetch multiple PlannedOrderComponent 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.
  - getPlannedOrderComponentByKey
```
@Nonnull
public PlannedOrderComponentByKeyFluentHelper getPlannedOrderComponentByKey(String reservation,
                                                                                     String reservationItem)
```
    Description copied from interface: PlannedOrderService
    
    Fetch a single PlannedOrderComponent entity using key fields.
    
    Specified by:
    
    getPlannedOrderComponentByKey in interface PlannedOrderService
    
    Parameters:
    
    reservation - Gibt einen alphanumerischen Schlüssel an, der den Beleg eindeutig identifiziert.
    Constraints: Not nullable, Maximum length: 10
    
    reservationItem - Reservierungsposition
    Constraints: Not nullable, Maximum length: 4
    
    Returns:
    
    A fluent helper to fetch a single PlannedOrderComponent 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.
  - createPlannedOrderComponent
```
@Nonnull
public PlannedOrderComponentCreateFluentHelper createPlannedOrderComponent(@Nonnull
                                                                                    PlannedOrderComponent plannedOrderComponent)
```
    Description copied from interface: PlannedOrderService
    
    Create a new PlannedOrderComponent entity and save it to the S/4HANA system.
    
    Specified by:
    
    createPlannedOrderComponent in interface PlannedOrderService
    
    Parameters:
    
    plannedOrderComponent - PlannedOrderComponent entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new PlannedOrderComponent entity. To perform execution, call the execute method on the fluent helper object.
  - updatePlannedOrderComponent
```
@Nonnull
public PlannedOrderComponentUpdateFluentHelper updatePlannedOrderComponent(@Nonnull
                                                                                    PlannedOrderComponent plannedOrderComponent)
```
    Description copied from interface: PlannedOrderService
    
    Update an existing PlannedOrderComponent entity and save it to the S/4HANA system.
    
    Specified by:
    
    updatePlannedOrderComponent in interface PlannedOrderService
    
    Parameters:
    
    plannedOrderComponent - PlannedOrderComponent entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing PlannedOrderComponent entity. To perform execution, call the execute method on the fluent helper object.
  - deletePlannedOrderComponent
```
@Nonnull
public PlannedOrderComponentDeleteFluentHelper deletePlannedOrderComponent(@Nonnull
                                                                                    PlannedOrderComponent plannedOrderComponent)
```
    Description copied from interface: PlannedOrderService
    
    Deletes an existing PlannedOrderComponent entity in the S/4HANA system.
    
    Specified by:
    
    deletePlannedOrderComponent in interface PlannedOrderService
    
    Parameters:
    
    plannedOrderComponent - PlannedOrderComponent entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing PlannedOrderComponent entity. To perform execution, call the execute method on the fluent helper object.
  - plannedOrderSchedule
```
@Nonnull
public PlannedOrderScheduleFluentHelper plannedOrderSchedule(String plannedOrder)
```
    Description copied from interface: PlannedOrderService
    
    Creates a fluent helper for the PlannedOrderSchedule OData function import.
    
    Specified by:
    
    plannedOrderSchedule in interface PlannedOrderService
    
    Parameters:
    
    plannedOrder - Planauftrag
    
    Constraints: Not nullable, Maximum length: 10
    
    Original parameter name from the Odata EDM: PlannedOrder
    
    Returns:
    
    A fluent helper object that will execute the PlannedOrderSchedule OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

Class DefaultPlannedOrderService

Details:

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.PlannedOrderService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultPlannedOrderService

Method Detail

withServicePath

batch

getAllPlannedOrder

getPlannedOrderByKey

createPlannedOrder

updatePlannedOrder

deletePlannedOrder

getAllPlannedOrderCapacity

getPlannedOrderCapacityByKey

getAllPlannedOrderComponent

getPlannedOrderComponentByKey

createPlannedOrderComponent

updatePlannedOrderComponent

deletePlannedOrderComponent

plannedOrderSchedule