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

Class DefaultPlanningCategoryService

java.lang.Object

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

All Implemented Interfaces:

BatchService<PlanningCategoryServiceBatch>, PlanningCategoryService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultPlanningCategoryService")
public class DefaultPlanningCategoryService
extends Object
implements PlanningCategoryService

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 inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.PlanningCategoryService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultPlanningCategoryService() Creates a service using PlanningCategoryService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultPlanningCategoryServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultPlanningCategoryService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPlanningCategoryService

public DefaultPlanningCategoryService()

Creates a service using PlanningCategoryService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultPlanningCategoryService withServicePath(@Nonnull
                                                               String servicePath)

Description copied from interface: PlanningCategoryService

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

Specified by:

withServicePath in interface PlanningCategoryService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultPlanningCategoryServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<PlanningCategoryServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllPlanningCategory

@Nonnull
public PlanningCategoryFluentHelper getAllPlanningCategory()

Description copied from interface: PlanningCategoryService

Fetch multiple PlanningCategory entities.

Specified by:

getAllPlanningCategory in interface PlanningCategoryService

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
public PlanningCategoryByKeyFluentHelper getPlanningCategoryByKey(String planningCategory)

Description copied from interface: PlanningCategoryService

Fetch a single PlanningCategory entity using key fields.

Specified by:

getPlanningCategoryByKey in interface PlanningCategoryService

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
public PlanningCategoryTextFluentHelper getAllPlanningCategoryText()

Description copied from interface: PlanningCategoryService

Fetch multiple PlanningCategoryText entities.

Specified by:

getAllPlanningCategoryText in interface PlanningCategoryService

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
public PlanningCategoryTextByKeyFluentHelper getPlanningCategoryTextByKey(String planningCategory,
                                                                                   String language)

Description copied from interface: PlanningCategoryService

Fetch a single PlanningCategoryText entity using key fields.

Specified by:

getPlanningCategoryTextByKey in interface PlanningCategoryService

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.