com.sap.cloud.sdk.s4hana.datamodel.odata.services.FunctionalAreaService 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.functionalarea.FunctionalAreaByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.functionalarea.FunctionalAreaFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.functionalarea.FunctionalAreaTextByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.functionalarea.FunctionalAreaTextFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.functionalarea.batch.FunctionalAreaServiceBatch;

/**
 * 
 * This service enables you to display functional area 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_FUNCTIONALAREA_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 FunctionalAreaService 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_FUNCTIONALAREA_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
    FunctionalAreaService withServicePath( @Nonnull final String servicePath );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.functionalarea.FunctionalArea
     * FunctionalArea} entity using key fields.
     * 
     * @param functionalArea
     *            Structure criterion for an enterprise or government based on functional aspects.
     *            
     *            Constraints: Not nullable, Maximum length: 16
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.functionalarea.FunctionalArea FunctionalArea}
     *         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.functionalarea.FunctionalAreaByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    FunctionalAreaByKeyFluentHelper getFunctionalAreaByKey( final String functionalArea );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.functionalarea.FunctionalAreaText
     * FunctionalAreaText} entity using key fields.
     * 
     * @param functionalArea
     *            Structure criterion for an enterprise or government based on functional aspects.
     *            
     *            Constraints: Not nullable, Maximum length: 16
     *            
     * @param language
     *            The language key indicates
     *            
     *            Constraints: Not nullable, Maximum length: 2
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.functionalarea.FunctionalAreaText
     *         FunctionalAreaText} 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.functionalarea.FunctionalAreaTextByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    FunctionalAreaTextByKeyFluentHelper
        getFunctionalAreaTextByKey( final String language, final String functionalArea );

}
OData Service:	API_FUNCTIONALAREA_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