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

Interface BusinessEventSubscriptionService

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

This service enables the caller to create a subscription for business events for a given subscriber. A subscription is required to activate the events so they are delivered to the event queue where they can be read. The information sent in the request as a payload is used to maintain a business events subscription, make the appropriate checks for restricted values and authorizations. Once an event subscription is maintained, the system displays a success or failure message in the response. # .

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: CA_BEH_SUBSCRIPTION_SRV
API Version: 1.2.0
Minimum ERP Version: 2302
Communication Scenario: OpenText Business Event Integration(SAP_COM_0007), Business Event Handling Integration (Obsolete)(SAP_COM_0121)
Scope Items: Business Event Handling(1NN)
Authentication Methods: x509

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull BusinessEventSubscriptionService 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.

    • getAllSubscriptionMaintain

      @Nonnull SubscriptionMaintainFluentHelper getAllSubscriptionMaintain()
      Deprecated.
      Fetch multiple SubscriptionMaintain entities.
      Returns:
      A fluent helper to fetch multiple SubscriptionMaintain 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.

    • getSubscriptionMaintainByKey

      @Nonnull SubscriptionMaintainByKeyFluentHelper getSubscriptionMaintainByKey(String busEventSubscriberCode, String sAPObjectType, String sAPObjectTaskCode)
      Deprecated.
      Fetch a single SubscriptionMaintain entity using key fields.
      Parameters:
      busEventSubscriberCode - Subscriber ID

      Constraints: Not nullable, Maximum length: 4

      sAPObjectTaskCode - SAP Object Task Code

      Constraints: Not nullable, Maximum length: 18

      sAPObjectType - SAP Object Type

      Constraints: Not nullable, Maximum length: 30

      Returns:
      A fluent helper to fetch a single SubscriptionMaintain 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.

    • createSubscriptionMaintain

      @Nonnull SubscriptionMaintainCreateFluentHelper createSubscriptionMaintain(@Nonnull SubscriptionMaintain subscriptionMaintain)
      Deprecated.
      Create a new SubscriptionMaintain entity and save it to the S/4HANA system.
      Parameters:
      subscriptionMaintain - SubscriptionMaintain entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new SubscriptionMaintain entity. To perform execution, call the execute method on the fluent helper object.

    • updateSubscriptionMaintain

      @Nonnull SubscriptionMaintainUpdateFluentHelper updateSubscriptionMaintain(@Nonnull SubscriptionMaintain subscriptionMaintain)
      Deprecated.
      Update an existing SubscriptionMaintain entity and save it to the S/4HANA system.
      Parameters:
      subscriptionMaintain - SubscriptionMaintain entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing SubscriptionMaintain entity. To perform execution, call the execute method on the fluent helper object.

    • getAllSubscriptionRead

      @Nonnull SubscriptionReadFluentHelper getAllSubscriptionRead()
      Deprecated.
      Fetch multiple SubscriptionRead entities.
      Returns:
      A fluent helper to fetch multiple SubscriptionRead 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.

    • getSubscriptionReadByKey

      @Nonnull SubscriptionReadByKeyFluentHelper getSubscriptionReadByKey(String busEventSubscriberCode, String sAPObjectType, String sAPObjectTaskCode)
      Deprecated.
      Fetch a single SubscriptionRead entity using key fields.
      Parameters:
      busEventSubscriberCode - Subscriber ID

      Constraints: Not nullable, Maximum length: 4

      sAPObjectTaskCode - SAP Object Task Code

      Constraints: Not nullable, Maximum length: 18

      sAPObjectType - SAP Object Type

      Constraints: Not nullable, Maximum length: 30

      Returns:
      A fluent helper to fetch a single SubscriptionRead 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.