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

Interface SegmentService

All Superinterfaces:
BatchService<SegmentServiceBatch>
All Known Implementing Classes:
DefaultSegmentService
@Deprecated public interface SegmentService extends BatchService<SegmentServiceBatch>
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

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

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: API_SEGMENT_SRV
API Version: 1.0.0
Minimum ERP Version: 2302
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: x509
Business Object: Segment

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull SegmentService withServicePath(@Nonnull String servicePath)
      Deprecated.
      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()
      Deprecated.
      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)
      Deprecated.
      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()
      Deprecated.
      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)
      Deprecated.
      Fetch a single SegmentText entity using key fields.
      Parameters:
      segment - Segment for Segmental Reporting

      Constraints: Not nullable, Maximum length: 10

      language - Language Key

      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.