@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultBusinessEventQueueService") public class DefaultBusinessEventQueueService extends Object implements 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.
Reference: SAP API Business Hub
OData Service: | C_BEHQUEUEDATA_CDS |
API Version: | 1 |
Communication Scenario: | Business Event Handling Integration (SAP_COM_0121) |
Scope Items: | Business Object Event Handling (1NN) |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultBusinessEventQueueService()
Creates a service using
BusinessEventQueueService.DEFAULT_SERVICE_PATH to send the requests. |
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. |
DefaultBusinessEventQueueService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
public DefaultBusinessEventQueueService()
BusinessEventQueueService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultBusinessEventQueueService withServicePath(@Nonnull String servicePath)
BusinessEventQueueService
withServicePath
in interface BusinessEventQueueService
servicePath
- Service path that will override the default.@Nonnull public BehqueuedataFluentHelper getAllBehqueuedata()
BusinessEventQueueService
Behqueuedata
entities.getAllBehqueuedata
in interface BusinessEventQueueService
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.@Nonnull public BehqueuedataByKeyFluentHelper getBehqueuedataByKey(UUID businessEvent)
BusinessEventQueueService
Behqueuedata
entity using key fields.getBehqueuedataByKey
in interface BusinessEventQueueService
businessEvent
- GUID of an EventConstraints: Not nullable
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.@Nonnull public BusinessObjectKeysFluentHelper getAllBusinessObjectKeys()
BusinessEventQueueService
BusinessObjectKeys
entities.getAllBusinessObjectKeys
in interface BusinessEventQueueService
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.@Nonnull public BusinessObjectKeysByKeyFluentHelper getBusinessObjectKeysByKey(String sAPObjectType)
BusinessEventQueueService
BusinessObjectKeys
entity using key fields.getBusinessObjectKeysByKey
in interface BusinessEventQueueService
sAPObjectType
- Indicates the name of the business object type.Constraints: Not nullable, Maximum length: 30
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.@Nonnull public BusObjectsFluentHelper getAllBusObjects()
BusinessEventQueueService
BusObjects
entities.getAllBusObjects
in interface BusinessEventQueueService
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.@Nonnull public BusObjectsByKeyFluentHelper getBusObjectsByKey(String sAPObjectType, String sAPObjectTypeName, String sAPObjectTaskCode, String sAPObjectTaskTypeName)
BusinessEventQueueService
BusObjects
entity using key fields.getBusObjectsByKey
in interface BusinessEventQueueService
sAPObjectType
- Indicates the name of the business object type.Constraints: Not nullable, Maximum length: 30
sAPObjectTypeName
- Indicates the text description of a particular business object type.Constraints: Not nullable, Maximum length: 40
sAPObjectTaskCode
- SAP Object Task CodeConstraints: Not nullable, Maximum length: 18
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
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.Copyright © 2018 SAP SE. All rights reserved.