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

Interface BusinessEventQueueService

All Superinterfaces:

BatchService<BusinessEventQueueServiceBatch>

All Known Implementing Classes:

DefaultBusinessEventQueueService

public interface BusinessEventQueueService
extends BatchService<BusinessEventQueueServiceBatch>

The service reads business events from a queue for a given subscriber. The business event contains the type and the key of the object triggering the event and the action. There are appropriate checks for restricted values and authorizations. The system displays a failure message in the response if the entry is invalid..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_C_BEHQUEUEDATA_CDS_0001
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
BehqueuedataFluentHelper	getAllBehqueuedata() Fetch multiple Behqueuedata entities.
BusinessObjectKeysFluentHelper	getAllBusinessObjectKeys() Fetch multiple BusinessObjectKeys entities.
BusObjectsFluentHelper	getAllBusObjects() Fetch multiple BusObjects entities.
BehqueuedataByKeyFluentHelper	getBehqueuedataByKey(UUID businessEvent) Fetch a single Behqueuedata entity using key fields.
BusinessObjectKeysByKeyFluentHelper	getBusinessObjectKeysByKey(String sAPObjectType) Fetch a single BusinessObjectKeys entity using key fields.
BusObjectsByKeyFluentHelper	getBusObjectsByKey(String sAPObjectType, String sAPObjectTypeName, String sAPObjectTaskCode, String sAPObjectTaskTypeName) Fetch a single BusObjects entity using key fields.
BusinessEventQueueService	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
BusinessEventQueueService 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.

getAllBehqueuedata

@Nonnull
BehqueuedataFluentHelper getAllBehqueuedata()

Fetch multiple Behqueuedata entities.

Returns:

A fluent helper to fetch multiple Behqueuedata 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.

getBehqueuedataByKey

@Nonnull
BehqueuedataByKeyFluentHelper getBehqueuedataByKey(UUID businessEvent)

Fetch a single Behqueuedata entity using key fields.

Parameters:

businessEvent - GUID of an Event

Constraints: Not nullable

Returns:

A fluent helper to fetch a single Behqueuedata 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.

getAllBusinessObjectKeys

@Nonnull
BusinessObjectKeysFluentHelper getAllBusinessObjectKeys()

Fetch multiple BusinessObjectKeys entities.

Returns:

A fluent helper to fetch multiple BusinessObjectKeys 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.

getBusinessObjectKeysByKey

@Nonnull
BusinessObjectKeysByKeyFluentHelper getBusinessObjectKeysByKey(String sAPObjectType)

Fetch a single BusinessObjectKeys entity using key fields.

Parameters:

sAPObjectType - SAP Object Type

Constraints: Not nullable, Maximum length: 30

Returns:

A fluent helper to fetch a single BusinessObjectKeys 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.

getAllBusObjects

@Nonnull
BusObjectsFluentHelper getAllBusObjects()

Fetch multiple BusObjects entities.

Returns:

A fluent helper to fetch multiple BusObjects 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.

getBusObjectsByKey

@Nonnull
BusObjectsByKeyFluentHelper getBusObjectsByKey(String sAPObjectType,
                                                        String sAPObjectTypeName,
                                                        String sAPObjectTaskCode,
                                                        String sAPObjectTaskTypeName)

Fetch a single BusObjects entity using key fields.

Parameters:

sAPObjectTaskCode - SAP Object Task Code

Constraints: Not nullable, Maximum length: 18

sAPObjectTypeName - SAP Object Type Name

Constraints: Not nullable, Maximum length: 80

sAPObjectType - SAP Object Type

Constraints: Not nullable, Maximum length: 30

sAPObjectTaskTypeName - SAP Object Task Type Name

Constraints: Not nullable, Maximum length: 80

Returns:

A fluent helper to fetch a single BusObjects 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.