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

Interface ReadSegmentService

All Known Implementing Classes:

DefaultReadSegmentService

public interface ReadSegmentService

This service enables you to read segment master data in an API call. It is based on the OData protocol, and can be consumed in Fiori apps and on other user interfaces.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_SEGMENT_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
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.

Method Detail

getAllSegment

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

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

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

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.