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

Interface PlanningCategoryService

All Superinterfaces:

BatchService<PlanningCategoryServiceBatch>

All Known Implementing Classes:

DefaultPlanningCategoryService

public interface PlanningCategoryService
extends BatchService<PlanningCategoryServiceBatch>

The service contains plan category and plan category text nodes.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PLANNINGCATEGORY_SRV
API Version:	1
Communication Scenario:	SAP Analytics Cloud for Planning Integration (SAP_COM_0087)
Scope Items:	Import Connection setup with SAP Analytics Cloud (1YB)
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
PlanningCategoryFluentHelper	getAllPlanningCategory() Fetch multiple PlanningCategory entities.
PlanningCategoryTextFluentHelper	getAllPlanningCategoryText() Fetch multiple PlanningCategoryText entities.
PlanningCategoryByKeyFluentHelper	getPlanningCategoryByKey(String planningCategory) Fetch a single PlanningCategory entity using key fields.
PlanningCategoryTextByKeyFluentHelper	getPlanningCategoryTextByKey(String planningCategory, String language) Fetch a single PlanningCategoryText entity using key fields.
PlanningCategoryService	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.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
PlanningCategoryService 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.

getAllPlanningCategory

@Nonnull
PlanningCategoryFluentHelper getAllPlanningCategory()

Fetch multiple PlanningCategory entities.

Returns:

A fluent helper to fetch multiple PlanningCategory 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.

getPlanningCategoryByKey

@Nonnull
PlanningCategoryByKeyFluentHelper getPlanningCategoryByKey(String planningCategory)

Fetch a single PlanningCategory entity using key fields.

Parameters:

planningCategory - Used to distinguish different sets of plan data.

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single PlanningCategory 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.

getAllPlanningCategoryText

@Nonnull
PlanningCategoryTextFluentHelper getAllPlanningCategoryText()

Fetch multiple PlanningCategoryText entities.

Returns:

A fluent helper to fetch multiple PlanningCategoryText 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.

getPlanningCategoryTextByKey

@Nonnull
PlanningCategoryTextByKeyFluentHelper getPlanningCategoryTextByKey(String planningCategory,
                                                                            String language)

Fetch a single PlanningCategoryText entity using key fields.

Parameters:

planningCategory - Used to distinguish different sets of plan data.

Constraints: Not nullable, Maximum length: 10

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

Returns:

A fluent helper to fetch a single PlanningCategoryText 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.