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

Interface BusinessEventSubscriptionService

All Known Implementing Classes:

DefaultBusinessEventSubscriptionService

public interface BusinessEventSubscriptionService

This service enables you to subscribe business event objects. You can also manage all the active and inactive objects. A subscription is an entry that enables you to be notified about the changes that are made to the business objects. It is based on the OData protocol, and can be consumed in Fiori apps and other user interfaces.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	CA_BEH_SUBSCRIPTION_SRV
API Version:	1
Communication Scenario:	Business Event Handling Integration (SAP_COM_0121)
Scope Items:	Business Object Event Handling (1NN)

Method Summary

Methods

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.

Method Detail

getAllSubscriptionRead

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

SubscriptionReadByKeyFluentHelper getSubscriptionReadByKey(String buseventsubscribercode,
                                                         String sapobjecttype,
                                                         String sapobjecttaskcode)

Fetch a single SubscriptionRead entity using key fields.

Parameters:

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

getAllSubscriptionMaintain

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

SubscriptionMaintainByKeyFluentHelper getSubscriptionMaintainByKey(String buseventsubscribercode,
                                                                 String sapobjecttype,
                                                                 String sapobjecttaskcode)

Fetch a single SubscriptionMaintain entity using key fields.

Parameters:

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

SubscriptionMaintainCreateFluentHelper createSubscriptionMaintain(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

SubscriptionMaintainUpdateFluentHelper updateSubscriptionMaintain(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.