com.sap.cloud.sdk.s4hana.datamodel.odata.services.DistributionChannelService 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.distributionchannel.DistributionChannelByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.distributionchannel.DistributionChannelFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.distributionchannel.DistributionChannelTextByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.distributionchannel.DistributionChannelTextFluentHelper;

/**
 * 
 * This service enables you to display distribution channel master data to be consumed in SAP Fiori apps and on other
 * user interfaces.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_DISTRIBUTIONCHANNEL_SRV
API Version: 1
Communication Scenario: SAP Analytics Cloud for Planning Integration (SAP_COM_0087)
Scope Items: Integration between SAP S/4HANA Cloud and SAP Analytics Cloud
 * (1YB)
Authentication Methods: Basic, x509
 * 
 */
public interface DistributionChannelService
{

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

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.distributionchannel.DistributionChannel
     * DistributionChannel} entity using key fields.
     * 
     * @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
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.distributionchannel.DistributionChannel
     *         DistributionChannel} 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.distributionchannel.DistributionChannelByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    DistributionChannelByKeyFluentHelper getDistributionChannelByKey( final String distributionChannel );

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

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.distributionchannel.DistributionChannelText
     * DistributionChannelText} entity using key fields.
     * 
     * @param language
     *            The language key indicates
     *            
     *            Constraints: Not nullable, Maximum length: 2
     *            
     * @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
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.distributionchannel.DistributionChannelText
     *         DistributionChannelText} 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.distributionchannel.DistributionChannelTextByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    DistributionChannelTextByKeyFluentHelper
        getDistributionChannelTextByKey( final String distributionChannel, final String language );

}
OData Service:	API_DISTRIBUTIONCHANNEL_SRV
API Version:	1
Communication Scenario:	SAP Analytics Cloud for Planning Integration (SAP_COM_0087)
Scope Items:	Integration between SAP S/4HANA Cloud and SAP Analytics Cloud * (1YB)
Authentication Methods:	Basic, x509