Interface CatalogProfileService

All Known Implementing Classes:
DefaultCatalogProfileService

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

This service enables you to read the details of a catalog profile. Catalog profile is used to determine which catalogs and code groups from the individual catalogs are to be accessed by the system for maintenance notifications. If the input in the request is not as expected then, the system displays appropriate error or warning messages in the response. .

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: APICATALOGPROFILE_0001
API Version: 1.0.0
Minimum ERP Version: 2302
Communication Scenario: Maintenance Processing Integration(SAP_COM_0397)
Scope Items: Reactive Maintenance(4HH), Proactive Maintenance(4HI), Improvement Maintenance(4VT), Operational and Overhead Maintenance(4WM), Corrective Maintenance(BH1), Emergency Maintenance(BH2), Preventive Maintenance(BJ2), Reactive Maintenance(OHH), Proactive Maintenance(OHI), Improvement Maintenance(OVT), Operational and Overhead Maintenance(OWM)
Authentication Methods: x509
Service Group Name: API_CATALOGPROFILE
Business Object: Maintenance Notification
  • Field Details

  • Method Details

    • withServicePath

      @Nonnull CatalogProfileService 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.
    • getAllMaintNotifCatalogAssignment

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

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

      @Nonnull GetByKeyRequestBuilder<Catalog> getMaintNotifCatalogAssignmentByKey(String maintNotifCatalogProfile, String maintNotificationCatalog, String maintNotifCodeGrpSrchPattern)
      Deprecated.
      Fetch a single Catalog entity using key fields.
      Parameters:
      maintNotifCatalogProfile - Catalog Profile

      Constraints: Not nullable, Maximum length: 9

      maintNotifCodeGrpSrchPattern - Search Pattern for Code Group/Selected Set

      Constraints: Not nullable, Maximum length: 8

      maintNotificationCatalog - Catalog

      Constraints: Not nullable, Maximum length: 1

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

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

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

      @Nonnull GetByKeyRequestBuilder<CatalogProfile> getMaintNotifCatalogProfileByKey(String maintNotifCatalogProfile)
      Deprecated.
      Fetch a single CatalogProfile entity using key fields.
      Parameters:
      maintNotifCatalogProfile - Catalog Profile

      Constraints: Not nullable, Maximum length: 9

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