• Home
• com.sap.cloud.s4hana.datamodel
• odata-api
• 2.13.2
• source code
• CentralPurchaseContractService.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.sap.cloud.sdk.s4hana.datamodel.odata.services.CentralPurchaseContractService 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 java.util.UUID;

import javax.annotation.Nonnull;

import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CentralPurchaseContract;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CentralPurchaseContractByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CentralPurchaseContractCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CentralPurchaseContractFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurContrDistrMessagesByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurContrDistrMessagesFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurContrItmDistributionByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurContrItmDistributionFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurchaseContractItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurchaseContractItemFluentHelper;

/**
 * 

 * With this inbound service, you can read and create a central purchase contract which allows purchasers from various
 * parts of the company at different locations to take advantage of the negotiated global agreement with suppliers.
 * 
 * 

 * Business
 * Documentation
 * 
 * 

 * Reference: SAP
 * API Business Hub
 * 
 * 
Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
OData Service:
API_CENTRAL_PURCHASECONTRACT_SRV
API Version:
1
Communication Scenario:
SAP S/4HANA Procurement Hub - Central Contract Management Integration (SAP_COM_0243)
Scope Items:
Central Purchase Contracts (2ME)
Authentication Methods:
Basic, x509
 * 
 */
public interface CentralPurchaseContractService
{

    /**
     * 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_CENTRAL_PURCHASECONTRACT_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
    CentralPurchaseContractService withServicePath( @Nonnull final String servicePath );

    /**
     * Fetch multiple
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CentralPurchaseContract
     * CentralPurchaseContract} entities.
     * 
     * @return A fluent helper to fetch multiple
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CentralPurchaseContract
     *         CentralPurchaseContract} 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.centralpurchasecontract.CentralPurchaseContractFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    CentralPurchaseContractFluentHelper getAllCentralPurchaseContract();

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CentralPurchaseContract
     * CentralPurchaseContract} entity using key fields.
     * 
     * @param centralPurchaseContract
     *            Central Purchase Contract
     *            

     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CentralPurchaseContract
     *         CentralPurchaseContract} 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.centralpurchasecontract.CentralPurchaseContractByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    CentralPurchaseContractByKeyFluentHelper getCentralPurchaseContractByKey( final String centralPurchaseContract );

    /**
     * Create a new
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CentralPurchaseContract
     * CentralPurchaseContract} entity and save it to the S/4HANA system.
     * 
     * @param centralPurchaseContract
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CentralPurchaseContract
     *            CentralPurchaseContract} 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.centralpurchasecontract.CentralPurchaseContract
     *         CentralPurchaseContract} entity. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CentralPurchaseContractCreateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    CentralPurchaseContractCreateFluentHelper
        createCentralPurchaseContract( @Nonnull final CentralPurchaseContract centralPurchaseContract );

    /**
     * Fetch multiple
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurchaseContractItem
     * CntrlPurchaseContractItem} entities.
     * 
     * @return A fluent helper to fetch multiple
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurchaseContractItem
     *         CntrlPurchaseContractItem} 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.centralpurchasecontract.CntrlPurchaseContractItemFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    CntrlPurchaseContractItemFluentHelper getAllCntrlPurchaseContractItem();

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurchaseContractItem
     * CntrlPurchaseContractItem} entity using key fields.
     * 
     * @param centralPurchaseContract
     *            Central Purchase Contract
     *            

     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @param centralPurchaseContractItem
     *            Central Purchase Contract Item
     *            

     *            Constraints: Not nullable, Maximum length: 5
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurchaseContractItem
     *         CntrlPurchaseContractItem} 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.centralpurchasecontract.CntrlPurchaseContractItemByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    CntrlPurchaseContractItemByKeyFluentHelper getCntrlPurchaseContractItemByKey(
        final String centralPurchaseContract,
        final String centralPurchaseContractItem );

    /**
     * Fetch multiple
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurContrDistrMessages
     * CntrlPurContrDistrMessages} entities.
     * 
     * @return A fluent helper to fetch multiple
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurContrDistrMessages
     *         CntrlPurContrDistrMessages} 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.centralpurchasecontract.CntrlPurContrDistrMessagesFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    CntrlPurContrDistrMessagesFluentHelper getAllCntrlPurContrDistrMessages();

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurContrDistrMessages
     * CntrlPurContrDistrMessages} entity using key fields.
     * 
     * @param sequenceNumber
     *            Sequence No. of Message during Contract Distribution
     *            

     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param distrResponseMessageUUID
     *            Generic Data Element for GUID Fields (X16)
     *            

     *            Constraints: Not nullable
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurContrDistrMessages
     *         CntrlPurContrDistrMessages} 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.centralpurchasecontract.CntrlPurContrDistrMessagesByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    CntrlPurContrDistrMessagesByKeyFluentHelper
        getCntrlPurContrDistrMessagesByKey( final String sequenceNumber, final UUID distrResponseMessageUUID );

    /**
     * Fetch multiple
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurContrItmDistribution
     * CntrlPurContrItmDistribution} entities.
     * 
     * @return A fluent helper to fetch multiple
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurContrItmDistribution
     *         CntrlPurContrItmDistribution} 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.centralpurchasecontract.CntrlPurContrItmDistributionFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    CntrlPurContrItmDistributionFluentHelper getAllCntrlPurContrItmDistribution();

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.centralpurchasecontract.CntrlPurContrItmDistribution
     * CntrlPurContrItmDistribution} entity using key fields.
     * 
     * @param distributionKey
     *            Distribution Number of Central Purchasing Document
     *            

     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param centralPurchaseContract
     *            Alphanumeric key uniquely identifying the document.
     *            

     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @param centralPurchaseContractItem
     *            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.centralpurchasecontract.CntrlPurContrItmDistribution
     *         CntrlPurContrItmDistribution} 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.centralpurchasecontract.CntrlPurContrItmDistributionByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    CntrlPurContrItmDistributionByKeyFluentHelper getCntrlPurContrItmDistributionByKey(
        final String centralPurchaseContract,
        final String centralPurchaseContractItem,
        final String distributionKey );

}