@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultBusinessEventQueueService") public class DefaultBusinessEventQueueService extends Object implements BusinessEventQueueService
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..
Reference: SAP API Business Hub
OData Service: | C_BEHQUEUEDATA_CDS |
API Version: | 1 |
Communication Scenario: | Business Event Handling Integration (SAP_COM_0121), OpenText Business Event Integration (SAP_COM_0007) |
Scope Items: | Business Event Handling (1NN) |
Authentication Methods: | Basic, x509 |
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 |
---|---|
DefaultBusinessEventQueueServiceBatch |
batch()
Instantiate a new FluentHelper instance for a single OData batch request.
|
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 DefaultBusinessEventQueueServiceBatch batch()
batch
in interface BatchService<BusinessEventQueueServiceBatch>
@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
- Indicates the GUID (Globally Unique Identifer) assigned to an event.
Constraints: 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: 80
sAPObjectTaskCode
- Indicates the code for the task that a business object type performs.
Constraints: 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: 80
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 © 2021 SAP SE. All rights reserved.