
com.sap.cloud.sdk.s4hana.datamodel.odata.services.BusinessSituationService Maven / Gradle / Ivy
/*
* 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.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituation.SitnDataContextByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituation.SitnDataContextFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituation.SitnInstanceByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituation.SitnInstanceFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituation.batch.BusinessSituationServiceBatch;
/**
*
* This synchronous inbound service enables you to read situation data context with the data provided in a payload. It
* is based on the OData protocol and the payload data can be consumed for machine learning and advanced analytics.
*
*
*
* Reference: SAP
* API Business Hub
*
* Details:
*
*
* OData Service:
* API_BUSINESS_SITUATION_SRV
*
*
* API Version:
* 1
*
*
* Communication Scenario:
* Business Situation Integration (SAP_COM_0345)
*
*
* Scope Items:
* Situation Handling (31N)
*
*
* Authentication Methods:
* Basic, x509
*
*
* Business Object:
* BusinessSituation
*
*
*
*/
public interface BusinessSituationService 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/API_BUSINESS_SITUATION_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
BusinessSituationService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituation.SitnDataContext
* SitnDataContext} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituation.SitnDataContext
* SitnDataContext} 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.businesssituation.SitnDataContextFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SitnDataContextFluentHelper getAllSitnDataContext();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituation.SitnDataContext
* SitnDataContext} entity using key fields.
*
* @param sitnDataContextID
* Situation Data Context ID
*
* Constraints: Not nullable, Maximum length: 32
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituation.SitnDataContext
* SitnDataContext} 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.businesssituation.SitnDataContextByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SitnDataContextByKeyFluentHelper getSitnDataContextByKey( final String sitnDataContextID );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituation.SitnInstance
* SitnInstance} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituation.SitnInstance SitnInstance}
* 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.businesssituation.SitnInstanceFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SitnInstanceFluentHelper getAllSitnInstance();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituation.SitnInstance
* SitnInstance} entity using key fields.
*
* @param sitnInstanceID
* Situation Instance ID
*
* Constraints: Not nullable, Maximum length: 32
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesssituation.SitnInstance SitnInstance}
* 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.businesssituation.SitnInstanceByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SitnInstanceByKeyFluentHelper getSitnInstanceByKey( final String sitnInstanceID );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy