@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultSegmentService") public class DefaultSegmentService extends Object implements SegmentService
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.
Reference: SAP API Business Hub
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) |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultSegmentService()
Creates a service using
SegmentService.DEFAULT_SERVICE_PATH to send the requests. |
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.
|
public DefaultSegmentService()
SegmentService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultSegmentService withServicePath(@Nonnull String servicePath)
SegmentService
withServicePath
in interface SegmentService
servicePath
- Service path that will override the default.@Nonnull public DefaultSegmentServiceBatch batch()
batch
in interface BatchService<SegmentServiceBatch>
@Nonnull public SegmentFluentHelper getAllSegment()
SegmentService
Segment
entities.getAllSegment
in interface SegmentService
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.@Nonnull public SegmentByKeyFluentHelper getSegmentByKey(String segment)
SegmentService
Segment
entity using
key fields.getSegmentByKey
in interface SegmentService
segment
- Segment for Segmental Reporting
Constraints: Not nullable, Maximum length: 10
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.@Nonnull public SegmentTextFluentHelper getAllSegmentText()
SegmentService
SegmentText
entities.getAllSegmentText
in interface SegmentService
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.@Nonnull public SegmentTextByKeyFluentHelper getSegmentTextByKey(String language, String segment)
SegmentService
SegmentText
entity
using key fields.getSegmentTextByKey
in interface SegmentService
language
- The language key indicates
Constraints: Not nullable, Maximum length: 2
segment
- Segment for Segmental Reporting
Constraints: Not nullable, Maximum length: 10
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.Copyright © 2019 SAP SE. All rights reserved.