Interface PlannedOrderService

All Known Implementing Classes:
DefaultPlannedOrderService

@Deprecated public interface PlannedOrderService
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: PLANNEDORDER_0001
API Version: 1.0.3
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
Service Group Name: API_PLANNEDORDER
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.
    • batch

      @Nonnull BatchRequestBuilder batch()
      Deprecated.
      Creates a batch request builder object.
      Returns:
      A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.
    • getAllPlannedOrderCapacity

      @Nonnull GetAllRequestBuilder<PlannedOrderCapacity> getAllPlannedOrderCapacity()
      Deprecated.
      Fetch multiple PlannedOrderCapacity entities.
      Returns:
      A request builder to fetch multiple PlannedOrderCapacity entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countPlannedOrderCapacity

      @Nonnull CountRequestBuilder<PlannedOrderCapacity> countPlannedOrderCapacity()
      Deprecated.
      Fetch the number of entries from the PlannedOrderCapacity entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of PlannedOrderCapacity entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getPlannedOrderCapacityByKey

      @Nonnull GetByKeyRequestBuilder<PlannedOrderCapacity> getPlannedOrderCapacityByKey(String plannedOrder, 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

      plannedOrder - Planned Order

      Constraints: Not nullable, Maximum length: 10

      capacityRqmtItemCapacity - Individual Capacity of a Capacity Requirement Item

      Constraints: Not nullable, Maximum length: 4

      Returns:
      A request builder to fetch a single PlannedOrderCapacity entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • createPlannedOrderCapacity

      @Nonnull CreateRequestBuilder<PlannedOrderCapacity> createPlannedOrderCapacity(@Nonnull PlannedOrderCapacity plannedOrderCapacity)
      Deprecated.
      Create a new PlannedOrderCapacity entity and save it to the S/4HANA system.
      Parameters:
      plannedOrderCapacity - PlannedOrderCapacity entity object that will be created in the S/4HANA system.
      Returns:
      A request builder to create a new PlannedOrderCapacity entity. To perform execution, call the execute method on the request builder object.
    • getAllPlannedOrderComponent

      @Nonnull GetAllRequestBuilder<PlannedOrderComponent> getAllPlannedOrderComponent()
      Deprecated.
      Fetch multiple PlannedOrderComponent entities.
      Returns:
      A request builder to fetch multiple PlannedOrderComponent entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countPlannedOrderComponent

      @Nonnull CountRequestBuilder<PlannedOrderComponent> countPlannedOrderComponent()
      Deprecated.
      Fetch the number of entries from the PlannedOrderComponent entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of PlannedOrderComponent entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getPlannedOrderComponentByKey

      @Nonnull GetByKeyRequestBuilder<PlannedOrderComponent> getPlannedOrderComponentByKey(String plannedOrder, String reservation, String reservationItem)
      Deprecated.
      Fetch a single PlannedOrderComponent entity using key fields.
      Parameters:
      plannedOrder - Planned Order

      Constraints: Not nullable, Maximum length: 10

      reservationItem - Reservation Item

      Constraints: Not nullable, Maximum length: 4

      reservation - Number of reservation/dependent requirements

      Constraints: Not nullable, Maximum length: 10

      Returns:
      A request builder to fetch a single PlannedOrderComponent entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • updatePlannedOrderComponent

      @Nonnull UpdateRequestBuilder<PlannedOrderComponent> 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 request builder to update an existing PlannedOrderComponent entity. To perform execution, call the execute method on the request builder object.
    • deletePlannedOrderComponent

      @Nonnull DeleteRequestBuilder<PlannedOrderComponent> 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 request builder to delete an existing PlannedOrderComponent entity. To perform execution, call the execute method on the request builder object.
    • getAllPlannedOrderHeader

      @Nonnull GetAllRequestBuilder<PlannedOrderHeader> getAllPlannedOrderHeader()
      Deprecated.
      Fetch multiple PlannedOrderHeader entities.
      Returns:
      A request builder to fetch multiple PlannedOrderHeader entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countPlannedOrderHeader

      @Nonnull CountRequestBuilder<PlannedOrderHeader> countPlannedOrderHeader()
      Deprecated.
      Fetch the number of entries from the PlannedOrderHeader entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of PlannedOrderHeader entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getPlannedOrderHeaderByKey

      @Nonnull GetByKeyRequestBuilder<PlannedOrderHeader> getPlannedOrderHeaderByKey(String plannedOrder)
      Deprecated.
      Fetch a single PlannedOrderHeader entity using key fields.
      Parameters:
      plannedOrder - Planned Order

      Constraints: Not nullable, Maximum length: 10

      Returns:
      A request builder to fetch a single PlannedOrderHeader entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • createPlannedOrderHeader

      @Nonnull CreateRequestBuilder<PlannedOrderHeader> createPlannedOrderHeader(@Nonnull PlannedOrderHeader plannedOrderHeader)
      Deprecated.
      Create a new PlannedOrderHeader entity and save it to the S/4HANA system.
      Parameters:
      plannedOrderHeader - PlannedOrderHeader entity object that will be created in the S/4HANA system.
      Returns:
      A request builder to create a new PlannedOrderHeader entity. To perform execution, call the execute method on the request builder object.
    • updatePlannedOrderHeader

      @Nonnull UpdateRequestBuilder<PlannedOrderHeader> updatePlannedOrderHeader(@Nonnull PlannedOrderHeader plannedOrderHeader)
      Deprecated.
      Update an existing PlannedOrderHeader entity and save it to the S/4HANA system.
      Parameters:
      plannedOrderHeader - PlannedOrderHeader entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing PlannedOrderHeader entity. To perform execution, call the execute method on the request builder object.
    • deletePlannedOrderHeader

      @Nonnull DeleteRequestBuilder<PlannedOrderHeader> deletePlannedOrderHeader(@Nonnull PlannedOrderHeader plannedOrderHeader)
      Deprecated.
      Deletes an existing PlannedOrderHeader entity in the S/4HANA system.
      Parameters:
      plannedOrderHeader - PlannedOrderHeader entity object that will be deleted in the S/4HANA system.
      Returns:
      A request builder to delete an existing PlannedOrderHeader entity. To perform execution, call the execute method on the request builder object.