com.sap.cloud.sdk.s4hana.datamodel.odata.services.BusinessEventQueueService Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
 */

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

import java.util.UUID;

import javax.annotation.Nonnull;

import com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BehqueuedataByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BehqueuedataFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusObjectsByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusObjectsFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusinessObjectKeysByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusinessObjectKeysFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.batch.BusinessEventQueueServiceBatch;

/**
 * 
 * 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)
 * 
 */
public interface BusinessEventQueueService extends BatchService
{

    /**
     * If no other path was provided via the {@link #withServicePath(String)} method, this is the default service path
     * used to access the endpoint.
     * 
     */
    String DEFAULT_SERVICE_PATH = "/sap/opu/odata/sap/C_BEHQUEUEDATA_CDS";

    /**
     * Overrides the default service path and returns a new service instance with the specified service path. Also
     * adjusts the respective entity URLs.
     * 
     * @param servicePath
     *            Service path that will override the default.
     * @return A new service instance with the specified service path.
     */
    @Nonnull
    BusinessEventQueueService withServicePath( @Nonnull final String servicePath );

    /**
     * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.Behqueuedata
     * Behqueuedata} entities.
     * 
     * @return A fluent helper to fetch multiple
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.Behqueuedata 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
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BehqueuedataFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    BehqueuedataFluentHelper getAllBehqueuedata();

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.Behqueuedata
     * Behqueuedata} entity using key fields.
     * 
     * @param businessEvent
     *            GUID of an Event
     *            
     *            Constraints: Not nullable
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.Behqueuedata 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
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BehqueuedataByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    BehqueuedataByKeyFluentHelper getBehqueuedataByKey( final UUID businessEvent );

    /**
     * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusinessObjectKeys
     * BusinessObjectKeys} entities.
     * 
     * @return A fluent helper to fetch multiple
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusinessObjectKeys
     *         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
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusinessObjectKeysFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    BusinessObjectKeysFluentHelper getAllBusinessObjectKeys();

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusinessObjectKeys
     * BusinessObjectKeys} entity using key fields.
     * 
     * @param sAPObjectType
     *            Indicates the name of the business object type.
     *            
     *            Constraints: Not nullable, Maximum length: 30
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusinessObjectKeys
     *         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
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusinessObjectKeysByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    BusinessObjectKeysByKeyFluentHelper getBusinessObjectKeysByKey( final String sAPObjectType );

    /**
     * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusObjects
     * BusObjects} entities.
     * 
     * @return A fluent helper to fetch multiple
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusObjects 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
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusObjectsFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    BusObjectsFluentHelper getAllBusObjects();

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusObjects
     * BusObjects} entity using key fields.
     * 
     * @param sAPObjectTaskCode
     *            SAP Object Task Code
     *            
     *            Constraints: Not nullable, Maximum length: 18
     *            
     * @param sAPObjectTypeName
     *            Indicates the text description of a particular business object type.
     *            
     *            Constraints: Not nullable, Maximum length: 40
     *            
     * @param sAPObjectType
     *            Indicates the name of the business object type.
     *            
     *            Constraints: Not nullable, Maximum length: 30
     *            
     * @param 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
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusObjects 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
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusObjectsByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    BusObjectsByKeyFluentHelper getBusObjectsByKey(
        final String sAPObjectType,
        final String sAPObjectTypeName,
        final String sAPObjectTaskCode,
        final String sAPObjectTaskTypeName );

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