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

Interface BusinessEventQueueService

All Known Implementing Classes:

DefaultBusinessEventQueueService

public interface BusinessEventQueueService

This service enables you to read the event queue, which contains a list of triggered business events. The content of the event is limited to a generic base data, but will not contain any application- specific data due to security constraints. In addition, you can also view the data relevant to the business object type. Each business object type has one or more key fields.

Business Documentation

Reference: SAP API Business Hub

Details:

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

Method Summary

Modifier and Type	Method and Description
C_BehqueuedataFluentHelper	getAllC_Behqueuedata() Fetch multiple C_Behqueuedata entities.
I_BusinessObjectKeysFluentHelper	getAllI_BusinessObjectKeys() Fetch multiple I_BusinessObjectKeys entities.
I_BusObjectsFluentHelper	getAllI_BusObjects() Fetch multiple I_BusObjects entities.
C_BehqueuedataByKeyFluentHelper	getC_BehqueuedataByKey(UUID businessEvent) Fetch a single C_Behqueuedata entity using key fields.
I_BusinessObjectKeysByKeyFluentHelper	getI_BusinessObjectKeysByKey(String sAPObjectType) Fetch a single I_BusinessObjectKeys entity using key fields.
I_BusObjectsByKeyFluentHelper	getI_BusObjectsByKey(String sAPObjectType, String sAPObjectTypeName, String sAPObjectTaskCode, String sAPObjectTaskTypeName) Fetch a single I_BusObjects entity using key fields.

Method Detail

getAllC_Behqueuedata

C_BehqueuedataFluentHelper getAllC_Behqueuedata()

Fetch multiple C_Behqueuedata entities.

Returns:

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

getC_BehqueuedataByKey

C_BehqueuedataByKeyFluentHelper getC_BehqueuedataByKey(UUID businessEvent)

Fetch a single C_Behqueuedata entity using key fields.

Parameters:

businessEvent - GUID of an Event

Constraints: Not nullable

Returns:

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

getAllI_BusinessObjectKeys

I_BusinessObjectKeysFluentHelper getAllI_BusinessObjectKeys()

Fetch multiple I_BusinessObjectKeys entities.

Returns:

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

getI_BusinessObjectKeysByKey

I_BusinessObjectKeysByKeyFluentHelper getI_BusinessObjectKeysByKey(String sAPObjectType)

Fetch a single I_BusinessObjectKeys entity using key fields.

Parameters:

sAPObjectType - Indicates the name of the business object type.

Constraints: Not nullable, Maximum length: 30

Returns:

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

getAllI_BusObjects

I_BusObjectsFluentHelper getAllI_BusObjects()

Fetch multiple I_BusObjects entities.

Returns:

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

getI_BusObjectsByKey

I_BusObjectsByKeyFluentHelper getI_BusObjectsByKey(String sAPObjectType,
                                                   String sAPObjectTypeName,
                                                   String sAPObjectTaskCode,
                                                   String sAPObjectTaskTypeName)

Fetch a single I_BusObjects entity using key fields.

Parameters:

sAPObjectTaskCode - SAP Object Task Code

Constraints: Not nullable, Maximum length: 18

sAPObjectTypeName - Indicates the text description of a particular business object type.

Constraints: Not nullable, Maximum length: 40

sAPObjectType - Indicates the name of the business object type.

Constraints: Not nullable, Maximum length: 30

sAPObjectTaskTypeName - Indicates the text description of a particular business object task, which is dependent on the language that you maintain in the text table.

Constraints: Not nullable, Maximum length: 40

Returns:

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