com.sap.cloud.sdk.s4hana.datamodel.odata.services.BusinessEventSubscriptionService 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 javax.annotation.Nonnull;

import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionMaintain;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionMaintainByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionMaintainCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionMaintainFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionMaintainUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionReadByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionReadFluentHelper;

/**
 * 
 * Business Events - Subscription Service.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: CA_BEH_SUBSCRIPTION_SRV
API Version: 1
Communication Scenario: Business Event Handling Integration (SAP_COM_0121)
Scope Items: Business Object Event Handling (1NN)
 * 
 */
public interface BusinessEventSubscriptionService
{

    /**
     * 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/CA_BEH_SUBSCRIPTION_SRV";

    /**
     * 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
    BusinessEventSubscriptionService withServicePath( @Nonnull final String servicePath );

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

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionMaintain
     * SubscriptionMaintain} entity using key fields.
     * 
     * @param busEventSubscriberCode
     *            Indicates the unique identification that you use to maintain the business object subscriptions
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param sAPObjectTaskCode
     *            SAP Object Task Code
     *            
     *            Constraints: Not nullable, Maximum length: 18
     *            
     * @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.businesseventsubscription.SubscriptionMaintain
     *         SubscriptionMaintain} 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.businesseventsubscription.SubscriptionMaintainByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    SubscriptionMaintainByKeyFluentHelper getSubscriptionMaintainByKey(
        final String busEventSubscriberCode,
        final String sAPObjectType,
        final String sAPObjectTaskCode );

    /**
     * Create a new
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionMaintain
     * SubscriptionMaintain} entity and save it to the S/4HANA system.
     * 
     * @param subscriptionMaintain
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionMaintain
     *            SubscriptionMaintain} entity object that will be created in the S/4HANA system.
     * @return A fluent helper to create a new
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionMaintain
     *         SubscriptionMaintain} entity. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionMaintainCreateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    SubscriptionMaintainCreateFluentHelper
        createSubscriptionMaintain( @Nonnull final SubscriptionMaintain subscriptionMaintain );

    /**
     * Update an existing
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionMaintain
     * SubscriptionMaintain} entity and save it to the S/4HANA system.
     * 
     * @param subscriptionMaintain
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionMaintain
     *            SubscriptionMaintain} entity object that will be updated in the S/4HANA system.
     * @return A fluent helper to update an existing
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionMaintain
     *         SubscriptionMaintain} entity. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionMaintainUpdateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    SubscriptionMaintainUpdateFluentHelper
        updateSubscriptionMaintain( @Nonnull final SubscriptionMaintain subscriptionMaintain );

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

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionRead
     * SubscriptionRead} entity using key fields.
     * 
     * @param busEventSubscriberCode
     *            Indicates the unique identification that you use to maintain the business object subscriptions
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param sAPObjectTaskCode
     *            SAP Object Task Code
     *            
     *            Constraints: Not nullable, Maximum length: 18
     *            
     * @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.businesseventsubscription.SubscriptionRead
     *         SubscriptionRead} 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.businesseventsubscription.SubscriptionReadByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    SubscriptionReadByKeyFluentHelper getSubscriptionReadByKey(
        final String busEventSubscriberCode,
        final String sAPObjectType,
        final String sAPObjectTaskCode );

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