All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sap.cloud.sdk.s4hana.datamodel.odata.services.PlannedOrderService Maven / Gradle / Ivy

/*
 * Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
 */

package com.sap.cloud.sdk.s4hana.datamodel.odata.services;

import javax.annotation.Nonnull;

import com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrder;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderCapacityByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderCapacityFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponent;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponentByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponentCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponentDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponentFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponentUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderScheduleFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.batch.PlannedOrderServiceBatch;

/**
 * 

* This service enables you to read, create, change, and delete planned orders as well as components belonging to * planned 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
* */ public interface PlannedOrderService extends BatchService { /** * If no other path was provided via the {@link #withServicePath(String)} method, this is the default service path * used to access the endpoint. * */ String DEFAULT_SERVICE_PATH = "/sap/opu/odata/sap/API_PLANNED_ORDERS"; /** * Overrides the default service path and returns a new service instance with the specified service path. Also * adjusts the respective entity URLs. * * @param servicePath * Service path that will override the default. * @return A new service instance with the specified service path. */ @Nonnull PlannedOrderService withServicePath( @Nonnull final String servicePath ); /** * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrder PlannedOrder} * entities. * * @return A fluent helper to fetch multiple * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrder 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 * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PlannedOrderFluentHelper getAllPlannedOrder(); /** * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrder PlannedOrder} * entity using key fields. * * @param plannedOrder * Number that specifically identifies a planned order for a material. *

* Constraints: Not nullable, Maximum length: 10 *

* @return A fluent helper to fetch a single * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrder 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 * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderByKeyFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PlannedOrderByKeyFluentHelper getPlannedOrderByKey( final String plannedOrder ); /** * Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrder PlannedOrder} * entity and save it to the S/4HANA system. * * @param plannedOrder * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrder PlannedOrder} * entity object that will be created in the S/4HANA system. * @return A fluent helper to create a new * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrder PlannedOrder} * entity. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderCreateFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PlannedOrderCreateFluentHelper createPlannedOrder( @Nonnull final PlannedOrder plannedOrder ); /** * Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrder * PlannedOrder} entity and save it to the S/4HANA system. * * @param plannedOrder * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrder PlannedOrder} * entity object that will be updated in the S/4HANA system. * @return A fluent helper to update an existing * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrder PlannedOrder} * entity. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderUpdateFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PlannedOrderUpdateFluentHelper updatePlannedOrder( @Nonnull final PlannedOrder plannedOrder ); /** * Deletes an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrder * PlannedOrder} entity in the S/4HANA system. * * @param plannedOrder * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrder PlannedOrder} * entity object that will be deleted in the S/4HANA system. * @return A fluent helper to delete an existing * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrder PlannedOrder} * entity. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderDeleteFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PlannedOrderDeleteFluentHelper deletePlannedOrder( @Nonnull final PlannedOrder plannedOrder ); /** * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderCapacity * PlannedOrderCapacity} entities. * * @return A fluent helper to fetch multiple * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderCapacity * 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 * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderCapacityFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PlannedOrderCapacityFluentHelper getAllPlannedOrderCapacity(); /** * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderCapacity * PlannedOrderCapacity} entity using key fields. * * @param capacityRequirementItem * Capacity Requirement Item *

* Constraints: Not nullable, Maximum length: 8 *

* @param capacityRequirement * ID of the Capacity Requirements Record *

* Constraints: Not nullable, Maximum length: 12 *

* @param capacityRqmtItemCapacity * Individual Capacity of a Capacity Requirement Item *

* Constraints: Not nullable, Maximum length: 4 *

* @return A fluent helper to fetch a single * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderCapacity * 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 * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderCapacityByKeyFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PlannedOrderCapacityByKeyFluentHelper getPlannedOrderCapacityByKey( final String capacityRequirement, final String capacityRequirementItem, final String capacityRqmtItemCapacity ); /** * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponent * PlannedOrderComponent} entities. * * @return A fluent helper to fetch multiple * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponent * 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 * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponentFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PlannedOrderComponentFluentHelper getAllPlannedOrderComponent(); /** * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponent * PlannedOrderComponent} entity using key fields. * * @param reservationItem * Reservation Item *

* Constraints: Not nullable, Maximum length: 4 *

* @param reservation * Alphanumeric key uniquely identifying the document. *

* Constraints: Not nullable, Maximum length: 10 *

* @return A fluent helper to fetch a single * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponent * 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 * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponentByKeyFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PlannedOrderComponentByKeyFluentHelper getPlannedOrderComponentByKey( final String reservation, final String reservationItem ); /** * Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponent * PlannedOrderComponent} entity and save it to the S/4HANA system. * * @param plannedOrderComponent * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponent * PlannedOrderComponent} entity object that will be created in the S/4HANA system. * @return A fluent helper to create a new * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponent * PlannedOrderComponent} entity. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponentCreateFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PlannedOrderComponentCreateFluentHelper createPlannedOrderComponent( @Nonnull final PlannedOrderComponent plannedOrderComponent ); /** * Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponent * PlannedOrderComponent} entity and save it to the S/4HANA system. * * @param plannedOrderComponent * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponent * PlannedOrderComponent} entity object that will be updated in the S/4HANA system. * @return A fluent helper to update an existing * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponent * PlannedOrderComponent} entity. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponentUpdateFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PlannedOrderComponentUpdateFluentHelper updatePlannedOrderComponent( @Nonnull final PlannedOrderComponent plannedOrderComponent ); /** * Deletes an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponent * PlannedOrderComponent} entity in the S/4HANA system. * * @param plannedOrderComponent * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponent * PlannedOrderComponent} entity object that will be deleted in the S/4HANA system. * @return A fluent helper to delete an existing * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponent * PlannedOrderComponent} entity. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderComponentDeleteFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PlannedOrderComponentDeleteFluentHelper deletePlannedOrderComponent( @Nonnull final PlannedOrderComponent plannedOrderComponent ); /** *

* Creates a fluent helper for the PlannedOrderSchedule OData function import. *

* * @param plannedOrder * Planned Order *

*

*

* Constraints: Not nullable, Maximum length: 10 *

*

* Original parameter name from the Odata EDM: PlannedOrder *

* @return A fluent helper object that will execute the PlannedOrderSchedule OData function import with the * provided parameters. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.PlannedOrderScheduleFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PlannedOrderScheduleFluentHelper plannedOrderSchedule( final String plannedOrder ); }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy