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

Class DefaultSegmentService

java.lang.Object

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

All Implemented Interfaces:

BatchService<SegmentServiceBatch>, SegmentService

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

The service enables you to retrieve segments and their names in the respective language..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_SEGMENT_SRV
API Version:	1
Communication Scenario:	SAP Analytics Cloud for Planning Integration (SAP_COM_0087), Finance - Cloud Consolidation Data Collection Integration (SAP_COM_0241)
Scope Items:	Import Connection setup with SAP Analytics Cloud (1YB), Group Reporting - Data from SAP Group Reporting Data Collection (287)
Authentication Methods:	Basic, x509, OAuth2

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.SegmentService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultSegmentService() Creates a service using SegmentService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultSegmentServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
SegmentFluentHelper	getAllSegment() Fetch multiple Segment entities.
SegmentTextFluentHelper	getAllSegmentText() Fetch multiple SegmentText entities.
SegmentByKeyFluentHelper	getSegmentByKey(String segment) Fetch a single Segment entity using key fields.
SegmentTextByKeyFluentHelper	getSegmentTextByKey(String language, String segment) Fetch a single SegmentText entity using key fields.
DefaultSegmentService	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

DefaultSegmentService

public DefaultSegmentService()

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

Method Detail

withServicePath

@Nonnull
public DefaultSegmentService withServicePath(@Nonnull
                                                      String servicePath)

Description copied from interface: SegmentService

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 SegmentService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultSegmentServiceBatch batch()

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

Specified by:

batch in interface BatchService<SegmentServiceBatch>

Returns:

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

getAllSegment

@Nonnull
public SegmentFluentHelper getAllSegment()

Description copied from interface: SegmentService

Fetch multiple Segment entities.

Specified by:

getAllSegment in interface SegmentService

Returns:

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

getSegmentByKey

@Nonnull
public SegmentByKeyFluentHelper getSegmentByKey(String segment)

Description copied from interface: SegmentService

Fetch a single Segment entity using key fields.

Specified by:

getSegmentByKey in interface SegmentService

Parameters:

segment - Segment for Segmental Reporting

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllSegmentText

@Nonnull
public SegmentTextFluentHelper getAllSegmentText()

Description copied from interface: SegmentService

Fetch multiple SegmentText entities.

Specified by:

getAllSegmentText in interface SegmentService

Returns:

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

getSegmentTextByKey

@Nonnull
public SegmentTextByKeyFluentHelper getSegmentTextByKey(String language,
                                                                 String segment)

Description copied from interface: SegmentService

Fetch a single SegmentText entity using key fields.

Specified by:

getSegmentTextByKey in interface SegmentService

Parameters:

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

segment - Segment for Segmental Reporting

Constraints: Not nullable, Maximum length: 10

Returns:

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