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

Class DefaultBusinessEventsSubscriptionService

java.lang.Object

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

All Implemented Interfaces:

BatchService<BusinessEventsSubscriptionServiceBatch>, BusinessEventsSubscriptionService

@Named(value="com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.DefaultBusinessEventsSubscriptionService")
public class DefaultBusinessEventsSubscriptionService
extends Object
implements BusinessEventsSubscriptionService

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 inherited from interface com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.BusinessEventsSubscriptionService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultBusinessEventsSubscriptionService() Creates a service using BusinessEventsSubscriptionService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultBusinessEventsSubscriptionService

public DefaultBusinessEventsSubscriptionService()

Creates a service using BusinessEventsSubscriptionService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultBusinessEventsSubscriptionService withServicePath(@Nonnull
                                                                         String servicePath)

Description copied from interface: BusinessEventsSubscriptionService

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Specified by:

withServicePath in interface BusinessEventsSubscriptionService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultBusinessEventsSubscriptionServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<BusinessEventsSubscriptionServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllSubscriptionMaintain

@Nonnull
public SubscriptionMaintainFluentHelper getAllSubscriptionMaintain()

Description copied from interface: BusinessEventsSubscriptionService

Fetch multiple SubscriptionMaintain entities.

Specified by:

getAllSubscriptionMaintain in interface BusinessEventsSubscriptionService

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
public SubscriptionMaintainByKeyFluentHelper getSubscriptionMaintainByKey(String busEventSubscriberCode,
                                                                                   String sAPObjectType,
                                                                                   String sAPObjectTaskCode)

Description copied from interface: BusinessEventsSubscriptionService

Fetch a single SubscriptionMaintain entity using key fields.

Specified by:

getSubscriptionMaintainByKey in interface BusinessEventsSubscriptionService

Parameters:

busEventSubscriberCode - Subscriber ID

Constraints: Not nullable, Maximum length: 4

sAPObjectType - SAP Object Type

Constraints: Not nullable, Maximum length: 30

sAPObjectTaskCode - SAP Object Task Code

Constraints: Not nullable, Maximum length: 18

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
public SubscriptionMaintainCreateFluentHelper createSubscriptionMaintain(@Nonnull
                                                                                  SubscriptionMaintain subscriptionMaintain)

Description copied from interface: BusinessEventsSubscriptionService

Create a new SubscriptionMaintain entity and save it to the S/4HANA system.

Specified by:

createSubscriptionMaintain in interface BusinessEventsSubscriptionService

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
public SubscriptionMaintainUpdateFluentHelper updateSubscriptionMaintain(@Nonnull
                                                                                  SubscriptionMaintain subscriptionMaintain)

Description copied from interface: BusinessEventsSubscriptionService

Update an existing SubscriptionMaintain entity and save it to the S/4HANA system.

Specified by:

updateSubscriptionMaintain in interface BusinessEventsSubscriptionService

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
public SubscriptionReadFluentHelper getAllSubscriptionRead()

Description copied from interface: BusinessEventsSubscriptionService

Fetch multiple SubscriptionRead entities.

Specified by:

getAllSubscriptionRead in interface BusinessEventsSubscriptionService

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
public SubscriptionReadByKeyFluentHelper getSubscriptionReadByKey(String busEventSubscriberCode,
                                                                           String sAPObjectType,
                                                                           String sAPObjectTaskCode)

Description copied from interface: BusinessEventsSubscriptionService

Fetch a single SubscriptionRead entity using key fields.

Specified by:

getSubscriptionReadByKey in interface BusinessEventsSubscriptionService

Parameters:

busEventSubscriberCode - Subscriber ID

Constraints: Not nullable, Maximum length: 4

sAPObjectType - SAP Object Type

Constraints: Not nullable, Maximum length: 30

sAPObjectTaskCode - SAP Object Task Code

Constraints: Not nullable, Maximum length: 18

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.