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

Class DefaultBusinessEventSubscriptionService

java.lang.Object

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

All Implemented Interfaces:

BatchService<BusinessEventSubscriptionServiceBatch>, BusinessEventSubscriptionService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultBusinessEventSubscriptionService")
public class DefaultBusinessEventSubscriptionService
extends Object
implements BusinessEventSubscriptionService

Business Events - Subscription Service.

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)

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.BusinessEventSubscriptionService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultBusinessEventSubscriptionService() Creates a service using BusinessEventSubscriptionService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBusinessEventSubscriptionService

public DefaultBusinessEventSubscriptionService()

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

Method Detail

withServicePath

@Nonnull
public DefaultBusinessEventSubscriptionService withServicePath(@Nonnull
                                                                        String servicePath)

Description copied from interface: BusinessEventSubscriptionService

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 BusinessEventSubscriptionService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultBusinessEventSubscriptionServiceBatch batch()

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

Specified by:

batch in interface BatchService<BusinessEventSubscriptionServiceBatch>

Returns:

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

getAllSubscriptionMaintain

@Nonnull
public SubscriptionMaintainFluentHelper getAllSubscriptionMaintain()

Description copied from interface: BusinessEventSubscriptionService

Fetch multiple SubscriptionMaintain entities.

Specified by:

getAllSubscriptionMaintain in interface BusinessEventSubscriptionService

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

Fetch a single SubscriptionMaintain entity using key fields.

Specified by:

getSubscriptionMaintainByKey in interface BusinessEventSubscriptionService

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

@Nonnull
public SubscriptionMaintainCreateFluentHelper createSubscriptionMaintain(@Nonnull
                                                                                  SubscriptionMaintain subscriptionMaintain)

Description copied from interface: BusinessEventSubscriptionService

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

Specified by:

createSubscriptionMaintain in interface BusinessEventSubscriptionService

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

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

Specified by:

updateSubscriptionMaintain in interface BusinessEventSubscriptionService

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

Fetch multiple SubscriptionRead entities.

Specified by:

getAllSubscriptionRead in interface BusinessEventSubscriptionService

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

Fetch a single SubscriptionRead entity using key fields.

Specified by:

getSubscriptionReadByKey in interface BusinessEventSubscriptionService

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.