Interface LabelFieldCatalogService

All Known Implementing Classes:
DefaultLabelFieldCatalogService

@Deprecated public interface LabelFieldCatalogService
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

This service enables you to retrieve label field placeholders from your SAP S/4HANA system and use them in the process of designing label templates in external systems. The service contains all relevant information about a label field placeholder such as ID, version, and the group that it belongs to..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: LABELFIELDCATALOG_0001
API Version: 1.0.0
Minimum ERP Version: 2302
Communication Scenario: Product Compliance - Label Template Authoring Integration(SAP_COM_0772)
Scope Items: Label Management(6MT)
Authentication Methods: x509
Service Group Name: API_PRODCMPLNCLBLFLDCTLG
Business Object: Product Compliance Label Field Group
  • Field Details

  • Method Details

    • withServicePath

      @Nonnull LabelFieldCatalogService 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.
    • batch

      @Nonnull BatchRequestBuilder batch()
      Deprecated.
      Creates a batch request builder object.
      Returns:
      A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.
    • getAllLabelFieldGroup

      @Nonnull GetAllRequestBuilder<LabelFieldGroup> getAllLabelFieldGroup()
      Deprecated.
      Fetch multiple LabelFieldGroup entities.
      Returns:
      A request builder to fetch multiple LabelFieldGroup entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countLabelFieldGroup

      @Nonnull CountRequestBuilder<LabelFieldGroup> countLabelFieldGroup()
      Deprecated.
      Fetch the number of entries from the LabelFieldGroup entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of LabelFieldGroup entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getLabelFieldGroupByKey

      @Nonnull GetByKeyRequestBuilder<LabelFieldGroup> getLabelFieldGroupByKey(String prodCmplncLabelFieldGroupID)
      Deprecated.
      Fetch a single LabelFieldGroup entity using key fields.
      Parameters:
      prodCmplncLabelFieldGroupID - Label Field Group ID

      Constraints: Not nullable, Maximum length: 21

      Returns:
      A request builder to fetch a single LabelFieldGroup entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getAllLabelFieldGroupText

      @Nonnull GetAllRequestBuilder<LabelFieldGroupText> getAllLabelFieldGroupText()
      Deprecated.
      Fetch multiple LabelFieldGroupText entities.
      Returns:
      A request builder to fetch multiple LabelFieldGroupText entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countLabelFieldGroupText

      @Nonnull CountRequestBuilder<LabelFieldGroupText> countLabelFieldGroupText()
      Deprecated.
      Fetch the number of entries from the LabelFieldGroupText entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of LabelFieldGroupText entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getLabelFieldGroupTextByKey

      @Nonnull GetByKeyRequestBuilder<LabelFieldGroupText> getLabelFieldGroupTextByKey(String prodCmplncLabelFieldGroupID, String language)
      Deprecated.
      Fetch a single LabelFieldGroupText entity using key fields.
      Parameters:
      prodCmplncLabelFieldGroupID - Label Field Group ID

      Constraints: Not nullable, Maximum length: 21

      language - Language Key

      Constraints: Not nullable, Maximum length: 2

      Returns:
      A request builder to fetch a single LabelFieldGroupText entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getAllLabelFieldVersion

      @Nonnull GetAllRequestBuilder<LabelFieldVersion> getAllLabelFieldVersion()
      Deprecated.
      Fetch multiple LabelFieldVersion entities.
      Returns:
      A request builder to fetch multiple LabelFieldVersion entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countLabelFieldVersion

      @Nonnull CountRequestBuilder<LabelFieldVersion> countLabelFieldVersion()
      Deprecated.
      Fetch the number of entries from the LabelFieldVersion entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of LabelFieldVersion entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getLabelFieldVersionByKey

      @Nonnull GetByKeyRequestBuilder<LabelFieldVersion> getLabelFieldVersionByKey(String prodCmplncLabelFieldVersionID)
      Deprecated.
      Fetch a single LabelFieldVersion entity using key fields.
      Parameters:
      prodCmplncLabelFieldVersionID - Label Field Version Identificator

      Constraints: Not nullable, Maximum length: 21

      Returns:
      A request builder to fetch a single LabelFieldVersion entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getAllLabelFieldVersionText

      @Nonnull GetAllRequestBuilder<LabelFieldVersionText> getAllLabelFieldVersionText()
      Deprecated.
      Fetch multiple LabelFieldVersionText entities.
      Returns:
      A request builder to fetch multiple LabelFieldVersionText entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countLabelFieldVersionText

      @Nonnull CountRequestBuilder<LabelFieldVersionText> countLabelFieldVersionText()
      Deprecated.
      Fetch the number of entries from the LabelFieldVersionText entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of LabelFieldVersionText entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getLabelFieldVersionTextByKey

      @Nonnull GetByKeyRequestBuilder<LabelFieldVersionText> getLabelFieldVersionTextByKey(String prodCmplncLabelFieldVersionID, String language)
      Deprecated.
      Fetch a single LabelFieldVersionText entity using key fields.
      Parameters:
      language - Language Key

      Constraints: Not nullable, Maximum length: 2

      prodCmplncLabelFieldVersionID - Label Field Version Identificator

      Constraints: Not nullable, Maximum length: 21

      Returns:
      A request builder to fetch a single LabelFieldVersionText entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.