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

Interface PlannedOrderService

All Superinterfaces:
BatchService<PlannedOrderServiceBatch>
All Known Implementing Classes:
DefaultPlannedOrderService
@Deprecated public interface PlannedOrderService extends BatchService<PlannedOrderServiceBatch>
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

The service contains planned order header, planned order capacity and planned order components. The information is sent in the request as a payload. You can read, create, change and delete components of orders and also use this service to schedule planned order operations. .

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: API_PLANNED_ORDERS
API Version: 1.0.0
Minimum ERP Version: 2302
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), Material Requirements Planning(O44)
Authentication Methods: x509
Business Object: Planned Order

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull PlannedOrderService 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.

    • getAllPlannedOrder

      @Nonnull PlannedOrderFluentHelper getAllPlannedOrder()
      Deprecated.
      Fetch multiple PlannedOrder entities.
      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 PlannedOrderByKeyFluentHelper getPlannedOrderByKey(String plannedOrder)
      Deprecated.
      Fetch a single PlannedOrder entity using key fields.
      Parameters:
      plannedOrder - Planned Order

      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 PlannedOrderCreateFluentHelper createPlannedOrder(@Nonnull PlannedOrder plannedOrder)
      Deprecated.
      Create a new PlannedOrder entity and save it to the S/4HANA system.
      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 PlannedOrderUpdateFluentHelper updatePlannedOrder(@Nonnull PlannedOrder plannedOrder)
      Deprecated.
      Update an existing PlannedOrder entity and save it to the S/4HANA system.
      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 PlannedOrderDeleteFluentHelper deletePlannedOrder(@Nonnull PlannedOrder plannedOrder)
      Deprecated.
      Deletes an existing PlannedOrder entity in the S/4HANA system.
      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 PlannedOrderCapacityFluentHelper getAllPlannedOrderCapacity()
      Deprecated.
      Fetch multiple PlannedOrderCapacity entities.
      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 PlannedOrderCapacityByKeyFluentHelper getPlannedOrderCapacityByKey(String capacityRequirement, String capacityRequirementItem, String capacityRqmtItemCapacity)
      Deprecated.
      Fetch a single PlannedOrderCapacity entity using key fields.
      Parameters:
      capacityRequirementItem - Capacity Requirement Item

      Constraints: Not nullable, Maximum length: 8

      capacityRequirement - ID of the Capacity Requirements Record

      Constraints: Not nullable, Maximum length: 12

      capacityRqmtItemCapacity - Individual Capacity of a Capacity Requirement Item

      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 PlannedOrderComponentFluentHelper getAllPlannedOrderComponent()
      Deprecated.
      Fetch multiple PlannedOrderComponent entities.
      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 PlannedOrderComponentByKeyFluentHelper getPlannedOrderComponentByKey(String reservation, String reservationItem)
      Deprecated.
      Fetch a single PlannedOrderComponent entity using key fields.
      Parameters:
      reservationItem - Reservation Item

      Constraints: Not nullable, Maximum length: 4

      reservation - Number of reservation/dependent requirements

      Constraints: Not nullable, Maximum length: 10

      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 PlannedOrderComponentCreateFluentHelper createPlannedOrderComponent(@Nonnull PlannedOrderComponent plannedOrderComponent)
      Deprecated.
      Create a new PlannedOrderComponent entity and save it to the S/4HANA system.
      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 PlannedOrderComponentUpdateFluentHelper updatePlannedOrderComponent(@Nonnull PlannedOrderComponent plannedOrderComponent)
      Deprecated.
      Update an existing PlannedOrderComponent entity and save it to the S/4HANA system.
      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 PlannedOrderComponentDeleteFluentHelper deletePlannedOrderComponent(@Nonnull PlannedOrderComponent plannedOrderComponent)
      Deprecated.
      Deletes an existing PlannedOrderComponent entity in the S/4HANA system.
      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 PlannedOrderScheduleFluentHelper plannedOrderSchedule(@Nonnull String plannedOrder)
      Deprecated.

      Creates a fluent helper for the PlannedOrderSchedule OData function import.

      Parameters:
      plannedOrder - Planned Order

      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.

    • schedulePlannedOrderOperation

      @Nonnull SchedulePlannedOrderOperationFluentHelper schedulePlannedOrderOperation(@Nonnull String plannedOrder, @Nonnull String capacityRequirement, @Nonnull String capacityRequirementItem, @Nonnull String capacityRqmtItemCapacity, @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 SchedulePlannedOrderOperation OData function import.

      Parameters:
      capacityRequirementItem - Counter

      Constraints: Not nullable, Maximum length: 8

      Original parameter name from the Odata EDM: CapacityRequirementItem

      opSchedldStartDate - Latest Start Date

      Constraints: Nullable, Precision: 0

      Original parameter name from the Odata EDM: OpSchedldStartDate

      capacityRequirement - Capacity Requirement

      Constraints: Not nullable, Maximum length: 12

      Original parameter name from the Odata EDM: CapacityRequirement

      plannedOrder - Planned Order

      Constraints: Not nullable, Maximum length: 10

      Original parameter name from the Odata EDM: PlannedOrder

      capacityRqmtItemCapacity - Counter

      Constraints: Not nullable, Maximum length: 4

      Original parameter name from the Odata EDM: CapacityRqmtItemCapacity

      opSchedulingStrategy - Component of the Version Number

      Constraints: Not nullable, Maximum length: 4

      Original parameter name from the Odata EDM: OpSchedulingStrategy

      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

      opSchedldStartTime - Latest Start Time

      Constraints: Nullable, Precision: 0

      Original parameter name from the Odata EDM: OpSchedldStartTime

      opSchedldEndDate - Latest End Date

      Constraints: Nullable, Precision: 0

      Original parameter name from the Odata EDM: OpSchedldEndDate

      opSchedldEndTime - Latest End Time

      Constraints: Nullable, Precision: 0

      Original parameter name from the Odata EDM: OpSchedldEndTime

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