Package com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface BusinessSituationTypeV2Service

All Superinterfaces:
BatchService<BusinessSituationTypeV2ServiceBatch>
All Known Implementing Classes:
DefaultBusinessSituationTypeV2Service
@Deprecated public interface BusinessSituationTypeV2Service extends BatchService<BusinessSituationTypeV2ServiceBatch>
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

This API is based on the OData protocol. It provides the situation instance and context data in the payload’s response. This includes the situation instance ID, situation creation time, situation status, situation type ID, situation template ID, situation anchor and trigger object key, anchor object, data context ID, data context, data context creation time, situation activity ID, and situation activity. The payload data can then be consumed, for example, by advanced analytics or automation. It also updates the situation action status for automation. The version 2 of this API also provides a version property in the entities Schema for Data Context Definition and Schema for Data Context Definition - Text to reflect different versions of the data context definition..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: CE_API_BUS_SITN_MSTRDATA_SRV_0002
API Version: 1.1.1
Minimum ERP Version: 2302
Communication Scenario: Business Situation Master Data Integration(SAP_COM_0376)
Scope Items: Situation Handling(31N)
Authentication Methods: x509
Business Object: Business Situation Type

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull BusinessSituationTypeV2Service withServicePath(@Nonnull String servicePath)
      Deprecated.
      Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.
      Parameters:
      servicePath - Service path that will override the default.
      Returns:
      A new service instance with the specified service path.

    • getAllSituationAction

      @Nonnull SituationActionFluentHelper getAllSituationAction()
      Deprecated.
      Fetch multiple SituationAction entities.
      Returns:
      A fluent helper to fetch multiple SituationAction 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.

    • getSituationActionByKey

      @Nonnull SituationActionByKeyFluentHelper getSituationActionByKey(String sitnDefTemplateID, String sitnActionID)
      Deprecated.
      Fetch a single SituationAction entity using key fields.
      Parameters:
      sitnDefTemplateID - Situation Standard Template ID

      Constraints: Not nullable, Maximum length: 32

      sitnActionID - Action ID

      Constraints: Not nullable, Maximum length: 32

      Returns:
      A fluent helper to fetch a single SituationAction 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.

    • getAllSituationActionText

      @Nonnull SituationActionTextFluentHelper getAllSituationActionText()
      Deprecated.
      Fetch multiple SituationActionText entities.
      Returns:
      A fluent helper to fetch multiple SituationActionText 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.

    • getSituationActionTextByKey

      @Nonnull SituationActionTextByKeyFluentHelper getSituationActionTextByKey(String sitnActionID, String language)
      Deprecated.
      Fetch a single SituationActionText entity using key fields.
      Parameters:
      language - Language Key

      Constraints: Not nullable, Maximum length: 2

      sitnActionID - Action ID

      Constraints: Not nullable, Maximum length: 32

      Returns:
      A fluent helper to fetch a single SituationActionText 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.

    • getAllSituationTemplateText

      @Nonnull SituationTemplateTextFluentHelper getAllSituationTemplateText()
      Deprecated.
      Fetch multiple SituationTemplateText entities.
      Returns:
      A fluent helper to fetch multiple SituationTemplateText 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.

    • getSituationTemplateTextByKey

      @Nonnull SituationTemplateTextByKeyFluentHelper getSituationTemplateTextByKey(String sitnDefTemplateID, String language)
      Deprecated.
      Fetch a single SituationTemplateText entity using key fields.
      Parameters:
      sitnDefTemplateID - Situation Standard Template ID

      Constraints: Not nullable, Maximum length: 32

      language - Language Key

      Constraints: Not nullable, Maximum length: 2

      Returns:
      A fluent helper to fetch a single SituationTemplateText 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.

    • getAllSituationType

      @Nonnull SituationTypeFluentHelper getAllSituationType()
      Deprecated.
      Fetch multiple SituationType entities.
      Returns:
      A fluent helper to fetch multiple SituationType 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.

    • getSituationTypeByKey

      @Nonnull SituationTypeByKeyFluentHelper getSituationTypeByKey(String sitnDefinitionID)
      Deprecated.
      Fetch a single SituationType entity using key fields.
      Parameters:
      sitnDefinitionID - Situation Type ID

      Constraints: Not nullable, Maximum length: 32

      Returns:
      A fluent helper to fetch a single SituationType 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.

    • getAllSituationTypeText

      @Nonnull SituationTypeTextFluentHelper getAllSituationTypeText()
      Deprecated.
      Fetch multiple SituationTypeText entities.
      Returns:
      A fluent helper to fetch multiple SituationTypeText 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.

    • getSituationTypeTextByKey

      @Nonnull SituationTypeTextByKeyFluentHelper getSituationTypeTextByKey(String sitnDefinitionID, String language)
      Deprecated.
      Fetch a single SituationTypeText entity using key fields.
      Parameters:
      sitnDefinitionID - Situation Type ID

      Constraints: Not nullable, Maximum length: 32

      language - Language Key

      Constraints: Not nullable, Maximum length: 2

      Returns:
      A fluent helper to fetch a single SituationTypeText 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.

    • getAllSituationTemplate

      @Nonnull SituationTemplateFluentHelper getAllSituationTemplate()
      Deprecated.
      Fetch multiple SituationTemplate entities.
      Returns:
      A fluent helper to fetch multiple SituationTemplate 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.

    • getSituationTemplateByKey

      @Nonnull SituationTemplateByKeyFluentHelper getSituationTemplateByKey(String sitnDefTemplateID)
      Deprecated.
      Fetch a single SituationTemplate entity using key fields.
      Parameters:
      sitnDefTemplateID - Situation Standard Template ID

      Constraints: Not nullable, Maximum length: 32

      Returns:
      A fluent helper to fetch a single SituationTemplate 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.

    • getAllSituationContextDefSchema

      @Nonnull SituationContextDefSchemaFluentHelper getAllSituationContextDefSchema()
      Deprecated.
      Fetch multiple SituationContextDefSchema entities.
      Returns:
      A fluent helper to fetch multiple SituationContextDefSchema 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.

    • getSituationContextDefSchemaByKey

      @Nonnull SituationContextDefSchemaByKeyFluentHelper getSituationContextDefSchemaByKey(String sitnDefTemplateID, Integer sitnDataCntxtVersion, Integer sitnDataCntxtFormatVersion, Integer sitnDataCntxtSchemaVersion)
      Deprecated.
      Fetch a single SituationContextDefSchema entity using key fields.
      Parameters:
      sitnDefTemplateID - Situation Standard Template ID

      Constraints: Not nullable, Maximum length: 32

      sitnDataCntxtVersion - Version of Data Context Definition

      Constraints: Not nullable

      sitnDataCntxtFormatVersion - Context Format Version

      Constraints: Not nullable

      sitnDataCntxtSchemaVersion - Schema Version of Data Context Definition

      Constraints: Not nullable

      Returns:
      A fluent helper to fetch a single SituationContextDefSchema 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.

    • getAllSituationContextDefText

      @Nonnull SituationContextDefTextFluentHelper getAllSituationContextDefText()
      Deprecated.
      Fetch multiple SituationContextDefText entities.
      Returns:
      A fluent helper to fetch multiple SituationContextDefText 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.

    • getSituationContextDefTextByKey

      @Nonnull SituationContextDefTextByKeyFluentHelper getSituationContextDefTextByKey(String sitnDefTemplateID, Integer sitnDataCntxtVersion, Integer sitnDataCntxtFormatVersion, Integer sitnDataCntxtSchemaVersion, String language)
      Deprecated.
      Fetch a single SituationContextDefText entity using key fields.
      Parameters:
      sitnDefTemplateID - Situation Standard Template ID

      Constraints: Not nullable, Maximum length: 32

      sitnDataCntxtVersion - Version of Data Context Definition

      Constraints: Not nullable

      language - Language Key

      Constraints: Not nullable, Maximum length: 2

      sitnDataCntxtFormatVersion - Context Format Version

      Constraints: Not nullable

      sitnDataCntxtSchemaVersion - Schema Version of Data Context Definition

      Constraints: Not nullable

      Returns:
      A fluent helper to fetch a single SituationContextDefText 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.