com.sap.cloud.sdk.s4hana.datamodel.odata.services.FinancialPlanningDataService 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.financialplanningdata.FinancialPlanData;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.financialplanningdata.FinancialPlanDataCreateFluentHelper;

/**
 * 
 * This service enables you to write financial plan data from one system to the other through an API call. It is based
 * on a OData service and can be consumed by external systems or user interfaces.
 * 
 * |.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_FINPLANNINGDATA_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 FinancialPlanningDataService
{

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

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

}

OData Service:	API_FINPLANNINGDATA_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