com.sap.cloud.sdk.s4hana.datamodel.odata.services.CustomerAndSupplierIndustryService 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.customerandsupplierindustry.CustomerSupplierIndustryByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customerandsupplierindustry.CustomerSupplierIndustryFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customerandsupplierindustry.CustomerSupplierIndustryTextByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customerandsupplierindustry.CustomerSupplierIndustryTextFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customerandsupplierindustry.batch.CustomerAndSupplierIndustryServiceBatch;

/**
 * 
 * This service enables you to read the industry master data of the customer and supplier in an API call. It is based on
 * the OData protocol, and can be consumed in Fiori apps and on other user interfaces.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_CUSTOMERSUPPLIERINDUSTRY_SRV
API Version: 1
Communication Scenario: SAP Business Objects Cloud for Planning Integration (SAP_COM_0087)
Scope Items: oData Integration with SAP Business Objects Cloud for
 * Planning (1YB)
 * 
 */
public interface CustomerAndSupplierIndustryService 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_CUSTOMERSUPPLIERINDUSTRY_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
    CustomerAndSupplierIndustryService withServicePath( @Nonnull final String servicePath );

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

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customerandsupplierindustry.CustomerSupplierIndustry
     * CustomerSupplierIndustry} entity using key fields.
     * 
     * @param industry
     *            An industry is a distinct group of companies with the same basic business activity. The industry key
     *            is used in selecting data for evaluations (for example, a vendor master data list). You can specify
     *            industries such as trade, banking, service, manufacturing, health care, public service, media and so
     *            on.
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customerandsupplierindustry.CustomerSupplierIndustry
     *         CustomerSupplierIndustry} 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.customerandsupplierindustry.CustomerSupplierIndustryByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    CustomerSupplierIndustryByKeyFluentHelper getCustomerSupplierIndustryByKey( final String industry );

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

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customerandsupplierindustry.CustomerSupplierIndustryText
     * CustomerSupplierIndustryText} entity using key fields.
     * 
     * @param language
     *            The language key indicates
     *            
     *            Constraints: Not nullable, Maximum length: 2
     *            
     * @param industry
     *            An industry is a distinct group of companies with the same basic business activity. The industry key
     *            is used in selecting data for evaluations (for example, a vendor master data list). You can specify
     *            industries such as trade, banking, service, manufacturing, health care, public service, media and so
     *            on.
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.customerandsupplierindustry.CustomerSupplierIndustryText
     *         CustomerSupplierIndustryText} 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.customerandsupplierindustry.CustomerSupplierIndustryTextByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    CustomerSupplierIndustryTextByKeyFluentHelper
        getCustomerSupplierIndustryTextByKey( final String language, final String industry );

}
OData Service:	API_CUSTOMERSUPPLIERINDUSTRY_SRV
API Version:	1
Communication Scenario:	SAP Business Objects Cloud for Planning Integration (SAP_COM_0087)
Scope Items:	oData Integration with SAP Business Objects Cloud for * Planning (1YB)