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

com.sap.cloud.sdk.s4hana.datamodel.odata.services.PurchaseOrderService 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.purchaseorder.PurOrdAccountAssignment;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurOrdAccountAssignmentByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurOrdAccountAssignmentFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurOrdAccountAssignmentUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurOrdPricingElementByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurOrdPricingElementFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrder;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItem;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItemCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItemDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItemUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderScheduleLine;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderScheduleLineByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderScheduleLineFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderScheduleLineUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.batch.PurchaseOrderServiceBatch;

/**
 * 

* This synchronous inbound service enables you to create, update, and delete purchase orders with the data provided in * a payload. It is based on the OData protocol and can be consumed in Fiori apps and on other user interfaces. *

*

* Business * Documentation *

*

* Reference: SAP * API Business Hub *

*

Details:

* * * * * * * * * * * * * * * * * * * * * * * * * *
OData Service:API_PURCHASEORDER_PROCESS_SRV
API Version:1
Communication Scenario:Distributed Manufacturing Integration (SAP_COM_0077), Purchase Order Integration (SAP_COM_0053)
Scope Items: Integration with SAP Distributed Manufacturing with SAP * S/4HANA Cloud (1NX), Consumable Purchasing (BNX), * Service and Material Procurement - Project-Based Services * (J13), Procurement of Direct Materials (J45)
Authentication Methods:Basic, x509
Business Object:PurchaseOrder
* */ public interface PurchaseOrderService 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_PURCHASEORDER_PROCESS_SRV"; /** * 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 PurchaseOrderService withServicePath( @Nonnull final String servicePath ); /** * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrder * PurchaseOrder} entities. * * @return A fluent helper to fetch multiple * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrder PurchaseOrder} * 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.purchaseorder.PurchaseOrderFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurchaseOrderFluentHelper getAllPurchaseOrder(); /** * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrder * PurchaseOrder} entity using key fields. * * @param purchaseOrder * Purchase Order Number *

* Constraints: Not nullable, Maximum length: 10 *

* @return A fluent helper to fetch a single * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrder PurchaseOrder} * 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.purchaseorder.PurchaseOrderByKeyFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurchaseOrderByKeyFluentHelper getPurchaseOrderByKey( final String purchaseOrder ); /** * Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrder * PurchaseOrder} entity and save it to the S/4HANA system. * * @param purchaseOrder * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrder PurchaseOrder} * 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.purchaseorder.PurchaseOrder PurchaseOrder} * entity. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderCreateFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurchaseOrderCreateFluentHelper createPurchaseOrder( @Nonnull final PurchaseOrder purchaseOrder ); /** * Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrder * PurchaseOrder} entity and save it to the S/4HANA system. * * @param purchaseOrder * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrder PurchaseOrder} * 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.purchaseorder.PurchaseOrder PurchaseOrder} * entity. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderUpdateFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurchaseOrderUpdateFluentHelper updatePurchaseOrder( @Nonnull final PurchaseOrder purchaseOrder ); /** * Deletes an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrder * PurchaseOrder} entity in the S/4HANA system. * * @param purchaseOrder * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrder PurchaseOrder} * 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.purchaseorder.PurchaseOrder PurchaseOrder} * entity. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderDeleteFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurchaseOrderDeleteFluentHelper deletePurchaseOrder( @Nonnull final PurchaseOrder purchaseOrder ); /** * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItem * PurchaseOrderItem} entities. * * @return A fluent helper to fetch multiple * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItem * PurchaseOrderItem} 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.purchaseorder.PurchaseOrderItemFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurchaseOrderItemFluentHelper getAllPurchaseOrderItem(); /** * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItem * PurchaseOrderItem} entity using key fields. * * @param purchaseOrder * Alphanumeric key uniquely identifying the document. *

* Constraints: Not nullable, Maximum length: 10 *

* @param purchaseOrderItem * Item Number of Purchase Order *

* Constraints: Not nullable, Maximum length: 5 *

* @return A fluent helper to fetch a single * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItem * PurchaseOrderItem} 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.purchaseorder.PurchaseOrderItemByKeyFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurchaseOrderItemByKeyFluentHelper getPurchaseOrderItemByKey( final String purchaseOrder, final String purchaseOrderItem ); /** * Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItem * PurchaseOrderItem} entity and save it to the S/4HANA system. * * @param purchaseOrderItem * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItem * PurchaseOrderItem} 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.purchaseorder.PurchaseOrderItem * PurchaseOrderItem} entity. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItemCreateFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurchaseOrderItemCreateFluentHelper createPurchaseOrderItem( @Nonnull final PurchaseOrderItem purchaseOrderItem ); /** * Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItem * PurchaseOrderItem} entity and save it to the S/4HANA system. * * @param purchaseOrderItem * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItem * PurchaseOrderItem} 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.purchaseorder.PurchaseOrderItem * PurchaseOrderItem} entity. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItemUpdateFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurchaseOrderItemUpdateFluentHelper updatePurchaseOrderItem( @Nonnull final PurchaseOrderItem purchaseOrderItem ); /** * Deletes an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItem * PurchaseOrderItem} entity in the S/4HANA system. * * @param purchaseOrderItem * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItem * PurchaseOrderItem} 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.purchaseorder.PurchaseOrderItem * PurchaseOrderItem} entity. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderItemDeleteFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurchaseOrderItemDeleteFluentHelper deletePurchaseOrderItem( @Nonnull final PurchaseOrderItem purchaseOrderItem ); /** * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderScheduleLine * PurchaseOrderScheduleLine} entities. * * @return A fluent helper to fetch multiple * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderScheduleLine * PurchaseOrderScheduleLine} 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.purchaseorder.PurchaseOrderScheduleLineFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurchaseOrderScheduleLineFluentHelper getAllPurchaseOrderScheduleLine(); /** * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderScheduleLine * PurchaseOrderScheduleLine} entity using key fields. * * @param purchasingDocument * Alphanumeric key uniquely identifying the document. *

* Constraints: Not nullable, Maximum length: 10 *

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

* Constraints: Not nullable, Maximum length: 4 *

* @param purchasingDocumentItem * Specifies the number that uniquely identifies an item in . *

* Constraints: Not nullable, Maximum length: 5 *

* @return A fluent helper to fetch a single * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderScheduleLine * PurchaseOrderScheduleLine} 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.purchaseorder.PurchaseOrderScheduleLineByKeyFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurchaseOrderScheduleLineByKeyFluentHelper getPurchaseOrderScheduleLineByKey( final String purchasingDocument, final String purchasingDocumentItem, final String scheduleLine ); /** * Update an existing * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderScheduleLine * PurchaseOrderScheduleLine} entity and save it to the S/4HANA system. * * @param purchaseOrderScheduleLine * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderScheduleLine * PurchaseOrderScheduleLine} 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.purchaseorder.PurchaseOrderScheduleLine * PurchaseOrderScheduleLine} entity. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurchaseOrderScheduleLineUpdateFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurchaseOrderScheduleLineUpdateFluentHelper updatePurchaseOrderScheduleLine( @Nonnull final PurchaseOrderScheduleLine purchaseOrderScheduleLine ); /** * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurOrdAccountAssignment * PurOrdAccountAssignment} entities. * * @return A fluent helper to fetch multiple * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurOrdAccountAssignment * PurOrdAccountAssignment} 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.purchaseorder.PurOrdAccountAssignmentFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurOrdAccountAssignmentFluentHelper getAllPurOrdAccountAssignment(); /** * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurOrdAccountAssignment * PurOrdAccountAssignment} entity using key fields. * * @param purchaseOrder * Alphanumeric key uniquely identifying the document. *

* Constraints: Not nullable, Maximum length: 10 *

* @param accountAssignmentNumber * Number uniquely defining the account assignment of a purchase document item. *

* Constraints: Not nullable, Maximum length: 2 *

* @param purchaseOrderItem * Specifies the number that uniquely identifies an item in . *

* Constraints: Not nullable, Maximum length: 5 *

* @return A fluent helper to fetch a single * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurOrdAccountAssignment * PurOrdAccountAssignment} 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.purchaseorder.PurOrdAccountAssignmentByKeyFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurOrdAccountAssignmentByKeyFluentHelper getPurOrdAccountAssignmentByKey( final String purchaseOrder, final String purchaseOrderItem, final String accountAssignmentNumber ); /** * Update an existing * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurOrdAccountAssignment * PurOrdAccountAssignment} entity and save it to the S/4HANA system. * * @param purOrdAccountAssignment * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurOrdAccountAssignment * PurOrdAccountAssignment} 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.purchaseorder.PurOrdAccountAssignment * PurOrdAccountAssignment} entity. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurOrdAccountAssignmentUpdateFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurOrdAccountAssignmentUpdateFluentHelper updatePurOrdAccountAssignment( @Nonnull final PurOrdAccountAssignment purOrdAccountAssignment ); /** * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurOrdPricingElement * PurOrdPricingElement} entities. * * @return A fluent helper to fetch multiple * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurOrdPricingElement * PurOrdPricingElement} 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.purchaseorder.PurOrdPricingElementFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurOrdPricingElementFluentHelper getAllPurOrdPricingElement(); /** * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurOrdPricingElement * PurOrdPricingElement} entity using key fields. * * @param pricingDocumentItem * The number that uniquely identifies the condition item. *

* Constraints: Not nullable, Maximum length: 6 *

* @param pricingProcedureCounter * Access number of the conditions within a step in the pricing procedure. *

* Constraints: Not nullable, Maximum length: 3 *

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

* Constraints: Not nullable, Maximum length: 10 *

* @param purchaseOrderItem * Specifies the number that uniquely identifies an item in . *

* Constraints: Not nullable, Maximum length: 5 *

* @param pricingProcedureStep * Number that determines the sequence of the condition within a procedure. *

* Constraints: Not nullable, Maximum length: 3 *

* @param pricingDocument * The internal number under which the system saves conditions that apply to a sales order, for example. *

* Constraints: Not nullable, Maximum length: 10 *

* @return A fluent helper to fetch a single * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaseorder.PurOrdPricingElement * PurOrdPricingElement} 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.purchaseorder.PurOrdPricingElementByKeyFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull PurOrdPricingElementByKeyFluentHelper getPurOrdPricingElementByKey( final String purchaseOrder, final String purchaseOrderItem, final String pricingDocument, final String pricingDocumentItem, final String pricingProcedureStep, final String pricingProcedureCounter ); }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy