Interface LabelTemplateMetadataService

All Known Implementing Classes:
DefaultLabelTemplateMetadataService

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

This service enables you to create or update existing metadata from your SAP S/4HANA system as a result of the design of label templates in external systems. The service provides relevant information about label template metadata, such as name, version, list of used label field versions (from the OData API: ***Label Field Catalog***)..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: CE_LABELTEMPLATEMETADATA_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_PCLBLTEMPLATEMETADATA
Business Object: Product Compliance Label Template
  • Field Details

  • Method Details

    • withServicePath

      @Nonnull LabelTemplateMetadataService 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.
    • getAllLabelTemplate

      @Nonnull GetAllRequestBuilder<LabelTemplate> getAllLabelTemplate()
      Deprecated.
      Fetch multiple LabelTemplate entities.
      Returns:
      A request builder to fetch multiple LabelTemplate 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.
    • countLabelTemplate

      @Nonnull CountRequestBuilder<LabelTemplate> countLabelTemplate()
      Deprecated.
      Fetch the number of entries from the LabelTemplate entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of LabelTemplate 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.
    • getLabelTemplateByKey

      @Nonnull GetByKeyRequestBuilder<LabelTemplate> getLabelTemplateByKey(String pCLblTemplateID)
      Deprecated.
      Fetch a single LabelTemplate entity using key fields.
      Parameters:
      pCLblTemplateID - Identifier

      Constraints: Not nullable, Maximum length: 21

      Returns:
      A request builder to fetch a single LabelTemplate 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.
    • createLabelTemplate

      @Nonnull CreateRequestBuilder<LabelTemplate> createLabelTemplate(@Nonnull LabelTemplate labelTemplate)
      Deprecated.
      Create a new LabelTemplate entity and save it to the S/4HANA system.
      Parameters:
      labelTemplate - LabelTemplate entity object that will be created in the S/4HANA system.
      Returns:
      A request builder to create a new LabelTemplate entity. To perform execution, call the execute method on the request builder object.
    • updateLabelTemplate

      @Nonnull UpdateRequestBuilder<LabelTemplate> updateLabelTemplate(@Nonnull LabelTemplate labelTemplate)
      Deprecated.
      Update an existing LabelTemplate entity and save it to the S/4HANA system.
      Parameters:
      labelTemplate - LabelTemplate entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing LabelTemplate entity. To perform execution, call the execute method on the request builder object.
    • getAllLabelTemplateVersion

      @Nonnull GetAllRequestBuilder<LabelTemplateVersion> getAllLabelTemplateVersion()
      Deprecated.
      Fetch multiple LabelTemplateVersion entities.
      Returns:
      A request builder to fetch multiple LabelTemplateVersion 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.
    • countLabelTemplateVersion

      @Nonnull CountRequestBuilder<LabelTemplateVersion> countLabelTemplateVersion()
      Deprecated.
      Fetch the number of entries from the LabelTemplateVersion entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of LabelTemplateVersion 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.
    • getLabelTemplateVersionByKey

      @Nonnull GetByKeyRequestBuilder<LabelTemplateVersion> getLabelTemplateVersionByKey(String pCLblTemplateVersionID)
      Deprecated.
      Fetch a single LabelTemplateVersion entity using key fields.
      Parameters:
      pCLblTemplateVersionID - Identifier

      Constraints: Not nullable, Maximum length: 21

      Returns:
      A request builder to fetch a single LabelTemplateVersion 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.
    • createLabelTemplateVersion

      @Nonnull CreateRequestBuilder<LabelTemplateVersion> createLabelTemplateVersion(@Nonnull LabelTemplateVersion labelTemplateVersion)
      Deprecated.
      Create a new LabelTemplateVersion entity and save it to the S/4HANA system.
      Parameters:
      labelTemplateVersion - LabelTemplateVersion entity object that will be created in the S/4HANA system.
      Returns:
      A request builder to create a new LabelTemplateVersion entity. To perform execution, call the execute method on the request builder object.
    • updateLabelTemplateVersion

      @Nonnull UpdateRequestBuilder<LabelTemplateVersion> updateLabelTemplateVersion(@Nonnull LabelTemplateVersion labelTemplateVersion)
      Deprecated.
      Update an existing LabelTemplateVersion entity and save it to the S/4HANA system.
      Parameters:
      labelTemplateVersion - LabelTemplateVersion entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing LabelTemplateVersion entity. To perform execution, call the execute method on the request builder object.
    • getAllLabelTemplateVersUsedFieldVers

      @Nonnull GetAllRequestBuilder<LabelTemplateVersUsedFieldVers> getAllLabelTemplateVersUsedFieldVers()
      Deprecated.
      Fetch multiple LabelTemplateVersUsedFieldVers entities.
      Returns:
      A request builder to fetch multiple LabelTemplateVersUsedFieldVers 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.
    • countLabelTemplateVersUsedFieldVers

      @Nonnull CountRequestBuilder<LabelTemplateVersUsedFieldVers> countLabelTemplateVersUsedFieldVers()
      Deprecated.
      Fetch the number of entries from the LabelTemplateVersUsedFieldVers entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of LabelTemplateVersUsedFieldVers 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.
    • getLabelTemplateVersUsedFieldVersByKey

      @Nonnull GetByKeyRequestBuilder<LabelTemplateVersUsedFieldVers> getLabelTemplateVersUsedFieldVersByKey(String prodCmplncLabelFieldVersionID, String pCLblTemplateVersionID)
      Deprecated.
      Fetch a single LabelTemplateVersUsedFieldVers entity using key fields.
      Parameters:
      pCLblTemplateVersionID - Identifier

      Constraints: Not nullable, Maximum length: 21

      prodCmplncLabelFieldVersionID - Label Field Version Identificator

      Constraints: Not nullable, Maximum length: 21

      Returns:
      A request builder to fetch a single LabelTemplateVersUsedFieldVers 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.
    • updateLabelTemplateVersUsedFieldVers

      @Nonnull UpdateRequestBuilder<LabelTemplateVersUsedFieldVers> updateLabelTemplateVersUsedFieldVers(@Nonnull LabelTemplateVersUsedFieldVers labelTemplateVersUsedFieldVers)
      Deprecated.
      Update an existing LabelTemplateVersUsedFieldVers entity and save it to the S/4HANA system.
      Parameters:
      labelTemplateVersUsedFieldVers - LabelTemplateVersUsedFieldVers entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing LabelTemplateVersUsedFieldVers entity. To perform execution, call the execute method on the request builder object.
    • deleteLabelTemplateVersUsedFieldVers

      @Nonnull DeleteRequestBuilder<LabelTemplateVersUsedFieldVers> deleteLabelTemplateVersUsedFieldVers(@Nonnull LabelTemplateVersUsedFieldVers labelTemplateVersUsedFieldVers)
      Deprecated.
      Deletes an existing LabelTemplateVersUsedFieldVers entity in the S/4HANA system.
      Parameters:
      labelTemplateVersUsedFieldVers - LabelTemplateVersUsedFieldVers entity object that will be deleted in the S/4HANA system.
      Returns:
      A request builder to delete an existing LabelTemplateVersUsedFieldVers entity. To perform execution, call the execute method on the request builder object.