@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultBusinessEventSubscriptionService") public class DefaultBusinessEventSubscriptionService extends Object implements BusinessEventSubscriptionService
This service lets the caller 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. # .
Reference: SAP API Business Hub
OData Service: | CA_BEH_SUBSCRIPTION_SRV |
API Version: | 1 |
Communication Scenario: | Business Event Handling Integration (SAP_COM_0121), OpenText Business Event Integration (SAP_COM_0007) |
Scope Items: | Business Event Handling (1NN) |
Authentication Methods: | Basic, x509 |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultBusinessEventSubscriptionService()
Creates a service using
BusinessEventSubscriptionService.DEFAULT_SERVICE_PATH to send the requests. |
Modifier and Type | Method and Description |
---|---|
DefaultBusinessEventSubscriptionServiceBatch |
batch()
Instantiate a new FluentHelper instance for a single OData batch request.
|
SubscriptionMaintainCreateFluentHelper |
createSubscriptionMaintain(SubscriptionMaintain subscriptionMaintain)
Create a new
SubscriptionMaintain entity and save it to the S/4HANA system. |
SubscriptionMaintainFluentHelper |
getAllSubscriptionMaintain()
Fetch multiple
SubscriptionMaintain entities. |
SubscriptionReadFluentHelper |
getAllSubscriptionRead()
Fetch multiple
SubscriptionRead entities. |
SubscriptionMaintainByKeyFluentHelper |
getSubscriptionMaintainByKey(String busEventSubscriberCode,
String sAPObjectType,
String sAPObjectTaskCode)
Fetch a single
SubscriptionMaintain entity using key fields. |
SubscriptionReadByKeyFluentHelper |
getSubscriptionReadByKey(String busEventSubscriberCode,
String sAPObjectType,
String sAPObjectTaskCode)
Fetch a single
SubscriptionRead entity using key fields. |
SubscriptionMaintainUpdateFluentHelper |
updateSubscriptionMaintain(SubscriptionMaintain subscriptionMaintain)
Update an existing
SubscriptionMaintain entity and save it to the S/4HANA system. |
DefaultBusinessEventSubscriptionService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
public DefaultBusinessEventSubscriptionService()
BusinessEventSubscriptionService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultBusinessEventSubscriptionService withServicePath(@Nonnull String servicePath)
BusinessEventSubscriptionService
withServicePath
in interface BusinessEventSubscriptionService
servicePath
- Service path that will override the default.@Nonnull public DefaultBusinessEventSubscriptionServiceBatch batch()
batch
in interface BatchService<BusinessEventSubscriptionServiceBatch>
@Nonnull public SubscriptionMaintainFluentHelper getAllSubscriptionMaintain()
BusinessEventSubscriptionService
SubscriptionMaintain
entities.getAllSubscriptionMaintain
in interface BusinessEventSubscriptionService
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.@Nonnull public SubscriptionMaintainByKeyFluentHelper getSubscriptionMaintainByKey(String busEventSubscriberCode, String sAPObjectType, String sAPObjectTaskCode)
BusinessEventSubscriptionService
SubscriptionMaintain
entity using key fields.getSubscriptionMaintainByKey
in interface BusinessEventSubscriptionService
busEventSubscriberCode
- Indicates the unique identification that you use to maintain the business object subscriptions
Constraints: Not nullable, Maximum length: 4
sAPObjectType
- Indicates the name of the business object type.
Constraints: Not nullable, Maximum length: 30
sAPObjectTaskCode
- Indicates the code for the task that a business object type performs.
Constraints: Not nullable, Maximum length: 18
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.@Nonnull public SubscriptionMaintainCreateFluentHelper createSubscriptionMaintain(@Nonnull SubscriptionMaintain subscriptionMaintain)
BusinessEventSubscriptionService
SubscriptionMaintain
entity and save it to the S/4HANA system.createSubscriptionMaintain
in interface BusinessEventSubscriptionService
subscriptionMaintain
- SubscriptionMaintain
entity object that will be created in the S/4HANA system.SubscriptionMaintain
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SubscriptionMaintainUpdateFluentHelper updateSubscriptionMaintain(@Nonnull SubscriptionMaintain subscriptionMaintain)
BusinessEventSubscriptionService
SubscriptionMaintain
entity and save it to the S/4HANA system.updateSubscriptionMaintain
in interface BusinessEventSubscriptionService
subscriptionMaintain
- SubscriptionMaintain
entity object that will be updated in the S/4HANA system.SubscriptionMaintain
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SubscriptionReadFluentHelper getAllSubscriptionRead()
BusinessEventSubscriptionService
SubscriptionRead
entities.getAllSubscriptionRead
in interface BusinessEventSubscriptionService
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.@Nonnull public SubscriptionReadByKeyFluentHelper getSubscriptionReadByKey(String busEventSubscriberCode, String sAPObjectType, String sAPObjectTaskCode)
BusinessEventSubscriptionService
SubscriptionRead
entity using key fields.getSubscriptionReadByKey
in interface BusinessEventSubscriptionService
busEventSubscriberCode
- Indicates the unique identification that you use to maintain the business object subscriptions
Constraints: Not nullable, Maximum length: 4
sAPObjectType
- Indicates the name of the business object type.
Constraints: Not nullable, Maximum length: 30
sAPObjectTaskCode
- Indicates the code for the task that a business object type performs.
Constraints: Not nullable, Maximum length: 18
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.Copyright © 2020 SAP SE. All rights reserved.