com.sap.cloud.sdk.s4hana.datamodel.odata.services.PurchaseContractService 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.namespaces.purchasecontract.PurCtrAccountByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrAccountFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrAddressByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrAddressFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrPartnersByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrPartnersFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContract;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContractByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContractCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContractFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContractItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContractItemFluentHelper;
/**
*
* This service enables you to read and create purchase contracts through an API call from a source system outside SAP
* S/4HANA Cloud.
*
*
*
* Reference: SAP
* API Business Hub
*
* Details:
*
*
* OData Service:
* API_PURCHASECONTRACT_PROCESS_SRV
*
*
* API Version:
* 1
*
*
* Communication Scenario:
* Distributed Manufacturing Integration (SAP_COM_0077), Purchase Contract Integration (SAP_COM_0101)
*
*
* Scope Items:
* Integration with SAP Distributed Manufacturing with SAP
* S/4HANA Cloud (1NX), Purchase Contract (BMD),
* Consumer and Customer Profiling (JC1),
* Consumable Purchasing (BNX),
* Service and Material Procurement - Project-Based Services
* (J13), Procurement of Direct Materials (J45)
*
*
* Authentication Methods:
* Basic, x509
*
*
*
*/
public interface PurchaseContractService
{
/**
* 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_PURCHASECONTRACT_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
PurchaseContractService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContract
* PurchaseContract} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContract
* PurchaseContract} 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.purchasecontract.PurchaseContractFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurchaseContractFluentHelper getAllPurchaseContract();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContract
* PurchaseContract} entity using key fields.
*
* @param purchaseContract
* Purchasing Contract Header
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContract
* PurchaseContract} 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.purchasecontract.PurchaseContractByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurchaseContractByKeyFluentHelper getPurchaseContractByKey( final String purchaseContract );
/**
* Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContract
* PurchaseContract} entity and save it to the S/4HANA system.
*
* @param purchaseContract
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContract
* PurchaseContract} 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.purchasecontract.PurchaseContract
* PurchaseContract} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContractCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurchaseContractCreateFluentHelper createPurchaseContract( @Nonnull final PurchaseContract purchaseContract );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContractItem
* PurchaseContractItem} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContractItem
* PurchaseContractItem} 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.purchasecontract.PurchaseContractItemFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurchaseContractItemFluentHelper getAllPurchaseContractItem();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContractItem
* PurchaseContractItem} entity using key fields.
*
* @param purchaseContract
* Purchasing Contract Header
*
* Constraints: Not nullable, Maximum length: 10
*
* @param purchaseContractItem
* Item Number of Purchasing Contract
*
* Constraints: Not nullable, Maximum length: 5
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurchaseContractItem
* PurchaseContractItem} 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.purchasecontract.PurchaseContractItemByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurchaseContractItemByKeyFluentHelper
getPurchaseContractItemByKey( final String purchaseContract, final String purchaseContractItem );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrAccount
* PurCtrAccount} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrAccount PurCtrAccount}
* 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.purchasecontract.PurCtrAccountFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurCtrAccountFluentHelper getAllPurCtrAccount();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrAccount
* PurCtrAccount} entity using key fields.
*
* @param purchaseContract
* Alphanumeric key uniquely identifying the document.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param accountAssignment
* Number uniquely defining the account assignment of a purchase document item.
*
* Constraints: Not nullable, Maximum length: 2
*
* @param purchaseContractItem
* 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.purchasecontract.PurCtrAccount PurCtrAccount}
* 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.purchasecontract.PurCtrAccountByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurCtrAccountByKeyFluentHelper getPurCtrAccountByKey(
final String accountAssignment,
final String purchaseContractItem,
final String purchaseContract );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrAddress
* PurCtrAddress} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrAddress PurCtrAddress}
* 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.purchasecontract.PurCtrAddressFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurCtrAddressFluentHelper getAllPurCtrAddress();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrAddress
* PurCtrAddress} entity using key fields.
*
* @param purchaseContract
* Purchasing Contract Header
*
* Constraints: Not nullable, Maximum length: 10
*
* @param purchaseContractItem
* Item Number of Purchasing Contract
*
* Constraints: Not nullable, Maximum length: 5
*
* @param addressID
* Internal key for identifying a Business Address Services address.
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrAddress PurCtrAddress}
* 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.purchasecontract.PurCtrAddressByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurCtrAddressByKeyFluentHelper getPurCtrAddressByKey(
final String purchaseContract,
final String addressID,
final String purchaseContractItem );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrPartners
* PurCtrPartners} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrPartners
* PurCtrPartners} 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.purchasecontract.PurCtrPartnersFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurCtrPartnersFluentHelper getAllPurCtrPartners();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrPartners
* PurCtrPartners} entity using key fields.
*
* @param partnerFunction
* The abbreviated form of the name that identifies the partner function.
*
* Constraints: Not nullable, Maximum length: 2
*
* @param purchaseContract
* Alphanumeric key uniquely identifying the document.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param plant
* Key uniquely identifying a plant.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param purchasingOrganization
* Denotes the purchasing organization.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param partnerCounter
* The sequential number that the system applies when there is more than one partner for a particular
* partner function.
*
* Constraints: Not nullable, Maximum length: 3
*
* @param purchaseContractItem
* Specifies the number that uniquely identifies an item in .
*
* Constraints: Not nullable, Maximum length: 5
*
* @param supplierSubrange
* Subdivision of a supplier's overall product range according to various criteria.
*
* Constraints: Not nullable, Maximum length: 6
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrPartners
* PurCtrPartners} 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.purchasecontract.PurCtrPartnersByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurCtrPartnersByKeyFluentHelper getPurCtrPartnersByKey(
final String purchaseContract,
final String purchaseContractItem,
final String purchasingOrganization,
final String partnerFunction,
final String plant,
final String supplierSubrange,
final String partnerCounter );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy