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

Go to download
/*
 * 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.purchasingsource.PurchasingSource;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasingsource.PurchasingSourceByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasingsource.PurchasingSourceCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasingsource.PurchasingSourceDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasingsource.PurchasingSourceFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasingsource.PurchasingSourceUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasingsource.batch.PurchasingSourceServiceBatch;

/**
 * 
 * This services enables a remote system to read, create and update purchasing sources from / in the SAP S/4HANA tenant.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_PURCHASING_SOURCE_SRV
API Version: 1
Communication Scenario: Purchasing Source Integration (SAP_COM_0162)
Scope Items: Purchase Contract (BMD)
 * 
 */
public interface PurchasingSourceService 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_PURCHASING_SOURCE_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
    PurchasingSourceService withServicePath( @Nonnull final String servicePath );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasingsource.PurchasingSource
     * PurchasingSource} entity using key fields.
     * 
     * @param material
     *            Alphanumeric key uniquely identifying the material.
     *            
     *            Constraints: Not nullable, Maximum length: 40
     *            
     * @param plant
     *            Specifies the key for a production facility or branch office within the company (that is, the company
     *            code).
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param sourceListRecord
     *            Alphanumeric key uniquely identifying the document.
     *            
     *            Constraints: Not nullable, Maximum length: 5
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasingsource.PurchasingSource
     *         PurchasingSource} 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.purchasingsource.PurchasingSourceByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    PurchasingSourceByKeyFluentHelper
        getPurchasingSourceByKey( final String material, final String plant, final String sourceListRecord );

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

    /**
     * Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasingsource.PurchasingSource
     * PurchasingSource} entity and save it to the S/4HANA system.
     * 
     * @param purchasingSource
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasingsource.PurchasingSource
     *            PurchasingSource} 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.purchasingsource.PurchasingSource
     *         PurchasingSource} entity. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasingsource.PurchasingSourceUpdateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    PurchasingSourceUpdateFluentHelper updatePurchasingSource( @Nonnull final PurchasingSource purchasingSource );

    /**
     * Deletes an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasingsource.PurchasingSource
     * PurchasingSource} entity in the S/4HANA system.
     * 
     * @param purchasingSource
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasingsource.PurchasingSource
     *            PurchasingSource} 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.purchasingsource.PurchasingSource
     *         PurchasingSource} entity. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasingsource.PurchasingSourceDeleteFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    PurchasingSourceDeleteFluentHelper deletePurchasingSource( @Nonnull final PurchasingSource purchasingSource );

}
OData Service:	API_PURCHASING_SOURCE_SRV
API Version:	1
Communication Scenario:	Purchasing Source Integration (SAP_COM_0162)
Scope Items:	Purchase Contract (BMD)