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

Class DefaultBusinessEventQueueService

java.lang.Object

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

All Implemented Interfaces:

BatchService<BusinessEventQueueServiceBatch>, BusinessEventQueueService

@Named(value="com.sap.cloud.sdk.s4hana.onpremise.v2020.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..

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 inherited from interface com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.BusinessEventQueueService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultBusinessEventQueueService() Creates a service using BusinessEventQueueService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBusinessEventQueueService

public DefaultBusinessEventQueueService()

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

Method Detail

withServicePath

@Nonnull
public DefaultBusinessEventQueueService withServicePath(@Nonnull
                                                                 String servicePath)

Description copied from interface: BusinessEventQueueService

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 BusinessEventQueueService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultBusinessEventQueueServiceBatch batch()

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

Specified by:

batch in interface BatchService<BusinessEventQueueServiceBatch>

Returns:

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

getAllBehqueuedata

@Nonnull
public BehqueuedataFluentHelper getAllBehqueuedata()

Description copied from interface: BusinessEventQueueService

Fetch multiple Behqueuedata entities.

Specified by:

getAllBehqueuedata in interface BusinessEventQueueService

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
public BehqueuedataByKeyFluentHelper getBehqueuedataByKey(UUID businessEvent)

Description copied from interface: BusinessEventQueueService

Fetch a single Behqueuedata entity using key fields.

Specified by:

getBehqueuedataByKey in interface BusinessEventQueueService

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
public BusinessObjectKeysFluentHelper getAllBusinessObjectKeys()

Description copied from interface: BusinessEventQueueService

Fetch multiple BusinessObjectKeys entities.

Specified by:

getAllBusinessObjectKeys in interface BusinessEventQueueService

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
public BusinessObjectKeysByKeyFluentHelper getBusinessObjectKeysByKey(String sAPObjectType)

Description copied from interface: BusinessEventQueueService

Fetch a single BusinessObjectKeys entity using key fields.

Specified by:

getBusinessObjectKeysByKey in interface BusinessEventQueueService

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
public BusObjectsFluentHelper getAllBusObjects()

Description copied from interface: BusinessEventQueueService

Fetch multiple BusObjects entities.

Specified by:

getAllBusObjects in interface BusinessEventQueueService

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
public BusObjectsByKeyFluentHelper getBusObjectsByKey(String sAPObjectType,
                                                               String sAPObjectTypeName,
                                                               String sAPObjectTaskCode,
                                                               String sAPObjectTaskTypeName)

Description copied from interface: BusinessEventQueueService

Fetch a single BusObjects entity using key fields.

Specified by:

getBusObjectsByKey in interface BusinessEventQueueService

Parameters:

sAPObjectType - SAP Object Type

Constraints: Not nullable, Maximum length: 30

sAPObjectTypeName - SAP Object Type Name

Constraints: Not nullable, Maximum length: 80

sAPObjectTaskCode - SAP Object Task Code

Constraints: Not nullable, Maximum length: 18

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.