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

Interface SegmentService

All Superinterfaces:

BatchService<SegmentServiceBatch>

All Known Implementing Classes:

DefaultSegmentService

public interface SegmentService
extends BatchService<SegmentServiceBatch>

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

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
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.
SegmentService	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
SegmentService 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.

getAllSegment

@Nonnull
SegmentFluentHelper getAllSegment()

Fetch multiple Segment entities.

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
SegmentByKeyFluentHelper getSegmentByKey(String segment)

Fetch a single Segment entity using key fields.

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
SegmentTextFluentHelper getAllSegmentText()

Fetch multiple SegmentText entities.

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
SegmentTextByKeyFluentHelper getSegmentTextByKey(String language,
                                                          String segment)

Fetch a single SegmentText entity using key fields.

Parameters:

segment - Segment for Segmental Reporting

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 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.