com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface StatisticalKeyFigureService

All Superinterfaces:

BatchService<StatisticalKeyFigureServiceBatch>

All Known Implementing Classes:

DefaultStatisticalKeyFigureService

public interface StatisticalKeyFigureService
extends BatchService<StatisticalKeyFigureServiceBatch>

This service enables you to create, read, update, or delete (CRUD) master data for statistical key figures. The service provides the data in an API call based on the open data protocol (OData). This service also supports you to create deep entity operation and batch processing..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_STATISTICALKEYFIGURE_SRV
API Version:	1
Communication Scenario:	Finance - Statistical Key Figure Integration (SAP_COM_0130)
Scope Items:	Overhead Cost Accounting (J54)
Authentication Methods:	Basic, x509

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
StatisticalKeyFigureCreateFluentHelper	createStatisticalKeyFigure(StatisticalKeyFigure statisticalKeyFigure) Create a new StatisticalKeyFigure entity and save it to the S/4HANA system.
StatisticalKeyFigureTextCreateFluentHelper	createStatisticalKeyFigureText(StatisticalKeyFigureText statisticalKeyFigureText) Create a new StatisticalKeyFigureText entity and save it to the S/4HANA system.
StatisticalKeyFigureDeleteFluentHelper	deleteStatisticalKeyFigure(StatisticalKeyFigure statisticalKeyFigure) Deletes an existing StatisticalKeyFigure entity in the S/4HANA system.
StatisticalKeyFigureTextDeleteFluentHelper	deleteStatisticalKeyFigureText(StatisticalKeyFigureText statisticalKeyFigureText) Deletes an existing StatisticalKeyFigureText entity in the S/4HANA system.
StatisticalKeyFigureFluentHelper	getAllStatisticalKeyFigure() Fetch multiple StatisticalKeyFigure entities.
StatisticalKeyFigureTextFluentHelper	getAllStatisticalKeyFigureText() Fetch multiple StatisticalKeyFigureText entities.
StatisticalKeyFigureByKeyFluentHelper	getStatisticalKeyFigureByKey(String statisticalKeyFigure, String controllingArea) Fetch a single StatisticalKeyFigure entity using key fields.
StatisticalKeyFigureTextByKeyFluentHelper	getStatisticalKeyFigureTextByKey(String language, String controllingArea, String statisticalKeyFigure) Fetch a single StatisticalKeyFigureText entity using key fields.
StatisticalKeyFigureUpdateFluentHelper	updateStatisticalKeyFigure(StatisticalKeyFigure statisticalKeyFigure) Update an existing StatisticalKeyFigure entity and save it to the S/4HANA system.
StatisticalKeyFigureTextUpdateFluentHelper	updateStatisticalKeyFigureText(StatisticalKeyFigureText statisticalKeyFigureText) Update an existing StatisticalKeyFigureText entity and save it to the S/4HANA system.
StatisticalKeyFigureService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
StatisticalKeyFigureService withServicePath(@Nonnull
                                                     String servicePath)

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

getAllStatisticalKeyFigure

@Nonnull
StatisticalKeyFigureFluentHelper getAllStatisticalKeyFigure()

Fetch multiple StatisticalKeyFigure entities.

Returns:

A fluent helper to fetch multiple StatisticalKeyFigure entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getStatisticalKeyFigureByKey

@Nonnull
StatisticalKeyFigureByKeyFluentHelper getStatisticalKeyFigureByKey(String statisticalKeyFigure,
                                                                            String controllingArea)

Fetch a single StatisticalKeyFigure entity using key fields.

Parameters:

statisticalKeyFigure - Statistical Key Figure

Constraints: Not nullable, Maximum length: 6

controllingArea - Controlling Area

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single StatisticalKeyFigure 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 execute method on the fluent helper object.

createStatisticalKeyFigure

@Nonnull
StatisticalKeyFigureCreateFluentHelper createStatisticalKeyFigure(@Nonnull
                                                                           StatisticalKeyFigure statisticalKeyFigure)

Create a new StatisticalKeyFigure entity and save it to the S/4HANA system.

Parameters:

statisticalKeyFigure - StatisticalKeyFigure entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new StatisticalKeyFigure entity. To perform execution, call the execute method on the fluent helper object.

updateStatisticalKeyFigure

@Nonnull
StatisticalKeyFigureUpdateFluentHelper updateStatisticalKeyFigure(@Nonnull
                                                                           StatisticalKeyFigure statisticalKeyFigure)

Update an existing StatisticalKeyFigure entity and save it to the S/4HANA system.

Parameters:

statisticalKeyFigure - StatisticalKeyFigure entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing StatisticalKeyFigure entity. To perform execution, call the execute method on the fluent helper object.

deleteStatisticalKeyFigure

@Nonnull
StatisticalKeyFigureDeleteFluentHelper deleteStatisticalKeyFigure(@Nonnull
                                                                           StatisticalKeyFigure statisticalKeyFigure)

Deletes an existing StatisticalKeyFigure entity in the S/4HANA system.

Parameters:

statisticalKeyFigure - StatisticalKeyFigure entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing StatisticalKeyFigure entity. To perform execution, call the execute method on the fluent helper object.

getAllStatisticalKeyFigureText

@Nonnull
StatisticalKeyFigureTextFluentHelper getAllStatisticalKeyFigureText()

Fetch multiple StatisticalKeyFigureText entities.

Returns:

A fluent helper to fetch multiple StatisticalKeyFigureText entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getStatisticalKeyFigureTextByKey

@Nonnull
StatisticalKeyFigureTextByKeyFluentHelper getStatisticalKeyFigureTextByKey(String language,
                                                                                    String controllingArea,
                                                                                    String statisticalKeyFigure)

Fetch a single StatisticalKeyFigureText entity using key fields.

Parameters:

statisticalKeyFigure - Statistical Key Figure

Constraints: Not nullable, Maximum length: 6

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

controllingArea - Controlling Area

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single StatisticalKeyFigureText 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 execute method on the fluent helper object.

createStatisticalKeyFigureText

@Nonnull
StatisticalKeyFigureTextCreateFluentHelper createStatisticalKeyFigureText(@Nonnull
                                                                                   StatisticalKeyFigureText statisticalKeyFigureText)

Create a new StatisticalKeyFigureText entity and save it to the S/4HANA system.

Parameters:

statisticalKeyFigureText - StatisticalKeyFigureText entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new StatisticalKeyFigureText entity. To perform execution, call the execute method on the fluent helper object.

updateStatisticalKeyFigureText

@Nonnull
StatisticalKeyFigureTextUpdateFluentHelper updateStatisticalKeyFigureText(@Nonnull
                                                                                   StatisticalKeyFigureText statisticalKeyFigureText)

Update an existing StatisticalKeyFigureText entity and save it to the S/4HANA system.

Parameters:

statisticalKeyFigureText - StatisticalKeyFigureText entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing StatisticalKeyFigureText entity. To perform execution, call the execute method on the fluent helper object.

deleteStatisticalKeyFigureText

@Nonnull
StatisticalKeyFigureTextDeleteFluentHelper deleteStatisticalKeyFigureText(@Nonnull
                                                                                   StatisticalKeyFigureText statisticalKeyFigureText)

Deletes an existing StatisticalKeyFigureText entity in the S/4HANA system.

Parameters:

statisticalKeyFigureText - StatisticalKeyFigureText entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing StatisticalKeyFigureText entity. To perform execution, call the execute method on the fluent helper object.