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

Interface ReadPlanningCategoryService

All Known Implementing Classes:

DefaultReadPlanningCategoryService

public interface ReadPlanningCategoryService

This service enables you to display planning category 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_PLANNINGCATEGORY_SRV
API Version:	1
Communication Scenario:	SAP Business Objects Cloud for Planning Integration (SAP_COM_0087)
Scope Items:	oData Integration with SAP Business Objects Cloud for Planning (1YB)

Method Summary

Methods

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.

Method Detail

getAllPlanningCategory

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

PlanningCategoryByKeyFluentHelper getPlanningCategoryByKey(String planningCategory)

Fetch a single PlanningCategory entity using key fields.

Parameters:

planningCategory - Specifies the BPC category.

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

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

PlanningCategoryTextByKeyFluentHelper getPlanningCategoryTextByKey(String planningCategory,
                                                                 String language)

Fetch a single PlanningCategoryText entity using key fields.

Parameters:

planningCategory - Specifies the BPC category.

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.