com.sap.cloud.sdk.s4hana.datamodel.odata.services.PurchaseRequisitionService 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.purchaserequisition.PurReqAddDeliveryByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurReqAddDeliveryFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurReqnAcctAssgmtByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurReqnAcctAssgmtFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionHeader;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionHeaderByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionHeaderCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionHeaderFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.ValidateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.batch.PurchaseRequisitionServiceBatch;
/**
*
* This inbound service enables you to create, read, update, and delete purchase requisitions through an API call from a
* source system inside as well as outside SAP S/4HANA Cloud or SAP S/4HANA onPremise.
*
*
*
* Reference: SAP
* API Business Hub
*
* Details:
*
*
* OData Service:
* API_PURCHASEREQ_PROCESS_SRV
*
*
* API Version:
* 1
*
*
* Communication Scenario:
* Purchase Requisition Integration (SAP_COM_0102), SAP S/4HANA Procurement Hub - Ariba GB - Hub to Ariba GB
* Integration (SAP_COM_0292)
*
*
* Scope Items:
* Requisitioning (18J),
* Guided Buying Integration (2NV),
* Consumable Purchasing (BNX),
* Service and Material Procurement - Project-Based Services
* (J13), Procurement of Direct Materials (J45)
*
*
* Authentication Methods:
* Basic, x509
*
*
*
*/
public interface PurchaseRequisitionService 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_PURCHASEREQ_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
PurchaseRequisitionService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionHeader
* PurchaseRequisitionHeader} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionHeader
* PurchaseRequisitionHeader} 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.purchaserequisition.PurchaseRequisitionHeaderFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurchaseRequisitionHeaderFluentHelper getAllPurchaseRequisitionHeader();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionHeader
* PurchaseRequisitionHeader} entity using key fields.
*
* @param purchaseRequisition
* Purchase requisition number
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionHeader
* PurchaseRequisitionHeader} 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.purchaserequisition.PurchaseRequisitionHeaderByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurchaseRequisitionHeaderByKeyFluentHelper getPurchaseRequisitionHeaderByKey( final String purchaseRequisition );
/**
* Create a new
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionHeader
* PurchaseRequisitionHeader} entity and save it to the S/4HANA system.
*
* @param purchaseRequisitionHeader
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionHeader
* PurchaseRequisitionHeader} 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.purchaserequisition.PurchaseRequisitionHeader
* PurchaseRequisitionHeader} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionHeaderCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurchaseRequisitionHeaderCreateFluentHelper
createPurchaseRequisitionHeader( @Nonnull final PurchaseRequisitionHeader purchaseRequisitionHeader );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionItem
* PurchaseRequisitionItem} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionItem
* PurchaseRequisitionItem} 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.purchaserequisition.PurchaseRequisitionItemFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurchaseRequisitionItemFluentHelper getAllPurchaseRequisitionItem();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionItem
* PurchaseRequisitionItem} entity using key fields.
*
* @param purchaseRequisitionItem
* Item number of purchase requisition
*
* Constraints: Not nullable, Maximum length: 5
*
* @param purchaseRequisition
* Purchase requisition number
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseRequisitionItem
* PurchaseRequisitionItem} 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.purchaserequisition.PurchaseRequisitionItemByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurchaseRequisitionItemByKeyFluentHelper
getPurchaseRequisitionItemByKey( final String purchaseRequisition, final String purchaseRequisitionItem );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurReqAddDelivery
* PurReqAddDelivery} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurReqAddDelivery
* PurReqAddDelivery} 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.purchaserequisition.PurReqAddDeliveryFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurReqAddDeliveryFluentHelper getAllPurReqAddDelivery();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurReqAddDelivery
* PurReqAddDelivery} entity using key fields.
*
* @param purchaseRequisitionItem
* Item number of purchase requisition
*
* Constraints: Not nullable, Maximum length: 5
*
* @param purchaseRequisition
* Purchase requisition number
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurReqAddDelivery
* PurReqAddDelivery} 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.purchaserequisition.PurReqAddDeliveryByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurReqAddDeliveryByKeyFluentHelper
getPurReqAddDeliveryByKey( final String purchaseRequisition, final String purchaseRequisitionItem );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurReqnAcctAssgmt
* PurReqnAcctAssgmt} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurReqnAcctAssgmt
* PurReqnAcctAssgmt} 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.purchaserequisition.PurReqnAcctAssgmtFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurReqnAcctAssgmtFluentHelper getAllPurReqnAcctAssgmt();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurReqnAcctAssgmt
* PurReqnAcctAssgmt} entity using key fields.
*
* @param purchaseRequisitionItem
* Specifies the number that uniquely identifies an item in .
*
* Constraints: Not nullable, Maximum length: 5
*
* @param purchaseRequisition
* Alphanumeric key uniquely identifying the document.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param purchaseReqnAcctAssgmtNumber
* Specifies the serial number of the account assignment item in the purchase requisition.
*
* Constraints: Not nullable, Maximum length: 2
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurReqnAcctAssgmt
* PurReqnAcctAssgmt} 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.purchaserequisition.PurReqnAcctAssgmtByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurReqnAcctAssgmtByKeyFluentHelper getPurReqnAcctAssgmtByKey(
final String purchaseRequisition,
final String purchaseRequisitionItem,
final String purchaseReqnAcctAssgmtNumber );
/**
*
* Creates a fluent helper for the Validate OData function import.
*
*
* @param purchaseRequisition
* Constraints: none
*
* Original parameter name from the Odata EDM: PurchaseRequisition
*
* @return A fluent helper object that will execute the Validate OData function import with the provided
* parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.ValidateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ValidateFluentHelper validate( final String purchaseRequisition );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy