com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services

Interface BusinessEventsSubscriptionService

All Superinterfaces:

BatchService<BusinessEventsSubscriptionServiceBatch>

All Known Implementing Classes:

DefaultBusinessEventsSubscriptionService

public interface BusinessEventsSubscriptionService
extends BatchService<BusinessEventsSubscriptionServiceBatch>

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..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_CA_BEH_SUBSCRIPTION_SRV
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
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.
BusinessEventsSubscriptionService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
BusinessEventsSubscriptionService withServicePath(@Nonnull
                                                           String servicePath)

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()

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)

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)

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)

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()

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)

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.