com.sap.cloud.sdk.s4hana.datamodel.odata.services.CustomerMaterialService 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.namespaces.customermaterial.CustomerMaterial;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customermaterial.CustomerMaterialByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customermaterial.CustomerMaterialCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customermaterial.CustomerMaterialDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customermaterial.CustomerMaterialFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customermaterial.CustomerMaterialUpdateFluentHelper;

/**
 * 
 * You can use this service to integrate external applications with customer material processing in SAP S/4HANA Cloud.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_CUSTOMER_MATERIAL_SRV
API Version: 1
Communication Scenario: Customer Material Info Record Integration (SAP_COM_0134)
Scope Items: Sell from Stock (BD9)
Authentication Methods: Basic, x509
Business Object: CustomerMaterial
 * 
 */
public interface CustomerMaterialService
{

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

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customermaterial.CustomerMaterial
     * CustomerMaterial} entity using key fields.
     * 
     * @param material
     *            Alphanumeric key uniquely identifying the material.
     *            
     *            Constraints: Not nullable, Maximum length: 40
     *            
     * @param distributionChannel
     *            The way in which products or services reach the customer. Typical examples of distribution channels
     *            are wholesale, retail, or direct sales.
     *            
     *            Constraints: Not nullable, Maximum length: 2
     *            
     * @param salesOrganization
     *            An organizational unit responsible for the sale of certain products or services. The responsibility of
     *            a sales organization may include legal liability for products and customer claims.
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param customer
     *            The customer to whom the condition or the customer-material info record applies.
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customermaterial.CustomerMaterial
     *         CustomerMaterial} 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.customermaterial.CustomerMaterialByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    CustomerMaterialByKeyFluentHelper getCustomerMaterialByKey(
        final String salesOrganization,
        final String distributionChannel,
        final String customer,
        final String material );

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

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

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

}
OData Service:	API_CUSTOMER_MATERIAL_SRV
API Version:	1
Communication Scenario:	Customer Material Info Record Integration (SAP_COM_0134)
Scope Items:	Sell from Stock (BD9)
Authentication Methods:	Basic, x509
Business Object:	CustomerMaterial