Class DefaultBusinessSituationTypeService
- All Implemented Interfaces:
BatchService<BusinessSituationTypeServiceBatch>,BusinessSituationTypeService
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. Only use the version 2 of this API. Do not use version 1 as this version is deprecated..
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | API_BUS_SITN_MSTRDATA_SRV |
| 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 Summary
Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.BusinessSituationTypeService
DEFAULT_SERVICE_PATH -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.Creates a service usingBusinessSituationTypeService.DEFAULT_SERVICE_PATHto send the requests. -
Method Summary
Modifier and TypeMethodDescriptionbatch()Deprecated.Deprecated.Fetch multipleSituationActionentities.Deprecated.Fetch multipleSituationActionTextentities.Deprecated.Fetch multipleSituationContextDefSchemaentities.Deprecated.Fetch multipleSituationContextDefTextentities.Deprecated.Fetch multipleSituationTemplateentities.Deprecated.Fetch multipleSituationTemplateTextentities.Deprecated.Fetch multipleSituationTypeentities.Deprecated.Fetch multipleSituationTypeTextentities.getSituationActionByKey(String sitnDefTemplateID, String sitnActionID) Deprecated.Fetch a singleSituationActionentity using key fields.getSituationActionTextByKey(String sitnActionID, String language) Deprecated.Fetch a singleSituationActionTextentity using key fields.getSituationContextDefSchemaByKey(String sitnDefTemplateID, Integer sitnDataCntxtFormatVersion, Integer sitnDataCntxtSchemaVersion) Deprecated.Fetch a singleSituationContextDefSchemaentity using key fields.getSituationContextDefTextByKey(String sitnDefTemplateID, Integer sitnDataCntxtFormatVersion, Integer sitnDataCntxtSchemaVersion, String language) Deprecated.Fetch a singleSituationContextDefTextentity using key fields.getSituationTemplateByKey(String sitnDefTemplateID) Deprecated.Fetch a singleSituationTemplateentity using key fields.getSituationTemplateTextByKey(String sitnDefTemplateID, String language) Deprecated.Fetch a singleSituationTemplateTextentity using key fields.getSituationTypeByKey(String sitnDefinitionID) Deprecated.Fetch a singleSituationTypeentity using key fields.getSituationTypeTextByKey(String sitnDefinitionID, String language) Deprecated.Fetch a singleSituationTypeTextentity using key fields.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.
-
Constructor Details
-
DefaultBusinessSituationTypeService
public DefaultBusinessSituationTypeService()Deprecated.Creates a service usingBusinessSituationTypeService.DEFAULT_SERVICE_PATHto send the requests.
-
-
Method Details
-
withServicePath
Deprecated.Description copied from interface:BusinessSituationTypeServiceOverrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.- Specified by:
withServicePathin interfaceBusinessSituationTypeService- Parameters:
servicePath- Service path that will override the default.- Returns:
- A new service instance with the specified service path.
-
batch
Deprecated.- Specified by:
batchin interfaceBatchService<BusinessSituationTypeServiceBatch>
-
getAllSituationAction
Deprecated.Description copied from interface:BusinessSituationTypeServiceFetch multipleSituationActionentities.- Specified by:
getAllSituationActionin interfaceBusinessSituationTypeService- Returns:
- A fluent helper to fetch multiple
SituationActionentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSituationActionByKey
@Nonnull public SituationActionByKeyFluentHelper getSituationActionByKey(String sitnDefTemplateID, String sitnActionID) Deprecated.Description copied from interface:BusinessSituationTypeServiceFetch a singleSituationActionentity using key fields.- Specified by:
getSituationActionByKeyin interfaceBusinessSituationTypeService- Parameters:
sitnDefTemplateID- Situation Standard Template IDConstraints: Not nullable, Maximum length: 32
sitnActionID- Action IDConstraints: Not nullable, Maximum length: 32
- Returns:
- A fluent helper to fetch a single
SituationActionentity 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 theexecutemethod on the fluent helper object.
-
getAllSituationActionText
Deprecated.Description copied from interface:BusinessSituationTypeServiceFetch multipleSituationActionTextentities.- Specified by:
getAllSituationActionTextin interfaceBusinessSituationTypeService- Returns:
- A fluent helper to fetch multiple
SituationActionTextentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSituationActionTextByKey
@Nonnull public SituationActionTextByKeyFluentHelper getSituationActionTextByKey(String sitnActionID, String language) Deprecated.Description copied from interface:BusinessSituationTypeServiceFetch a singleSituationActionTextentity using key fields.- Specified by:
getSituationActionTextByKeyin interfaceBusinessSituationTypeService- Parameters:
sitnActionID- Action IDConstraints: Not nullable, Maximum length: 32
language- Language KeyConstraints: Not nullable, Maximum length: 2
- Returns:
- A fluent helper to fetch a single
SituationActionTextentity 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 theexecutemethod on the fluent helper object.
-
getAllSituationTemplateText
Deprecated.Description copied from interface:BusinessSituationTypeServiceFetch multipleSituationTemplateTextentities.- Specified by:
getAllSituationTemplateTextin interfaceBusinessSituationTypeService- Returns:
- A fluent helper to fetch multiple
SituationTemplateTextentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSituationTemplateTextByKey
@Nonnull public SituationTemplateTextByKeyFluentHelper getSituationTemplateTextByKey(String sitnDefTemplateID, String language) Deprecated.Description copied from interface:BusinessSituationTypeServiceFetch a singleSituationTemplateTextentity using key fields.- Specified by:
getSituationTemplateTextByKeyin interfaceBusinessSituationTypeService- Parameters:
sitnDefTemplateID- Situation Standard Template IDConstraints: Not nullable, Maximum length: 32
language- Language KeyConstraints: Not nullable, Maximum length: 2
- Returns:
- A fluent helper to fetch a single
SituationTemplateTextentity 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 theexecutemethod on the fluent helper object.
-
getAllSituationType
Deprecated.Description copied from interface:BusinessSituationTypeServiceFetch multipleSituationTypeentities.- Specified by:
getAllSituationTypein interfaceBusinessSituationTypeService- Returns:
- A fluent helper to fetch multiple
SituationTypeentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSituationTypeByKey
Deprecated.Description copied from interface:BusinessSituationTypeServiceFetch a singleSituationTypeentity using key fields.- Specified by:
getSituationTypeByKeyin interfaceBusinessSituationTypeService- Parameters:
sitnDefinitionID- Situation Type IDConstraints: Not nullable, Maximum length: 32
- Returns:
- A fluent helper to fetch a single
SituationTypeentity 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 theexecutemethod on the fluent helper object.
-
getAllSituationTypeText
Deprecated.Description copied from interface:BusinessSituationTypeServiceFetch multipleSituationTypeTextentities.- Specified by:
getAllSituationTypeTextin interfaceBusinessSituationTypeService- Returns:
- A fluent helper to fetch multiple
SituationTypeTextentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSituationTypeTextByKey
@Nonnull public SituationTypeTextByKeyFluentHelper getSituationTypeTextByKey(String sitnDefinitionID, String language) Deprecated.Description copied from interface:BusinessSituationTypeServiceFetch a singleSituationTypeTextentity using key fields.- Specified by:
getSituationTypeTextByKeyin interfaceBusinessSituationTypeService- Parameters:
sitnDefinitionID- Situation Type IDConstraints: Not nullable, Maximum length: 32
language- Language KeyConstraints: Not nullable, Maximum length: 2
- Returns:
- A fluent helper to fetch a single
SituationTypeTextentity 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 theexecutemethod on the fluent helper object.
-
getAllSituationTemplate
Deprecated.Description copied from interface:BusinessSituationTypeServiceFetch multipleSituationTemplateentities.- Specified by:
getAllSituationTemplatein interfaceBusinessSituationTypeService- Returns:
- A fluent helper to fetch multiple
SituationTemplateentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSituationTemplateByKey
@Nonnull public SituationTemplateByKeyFluentHelper getSituationTemplateByKey(String sitnDefTemplateID) Deprecated.Description copied from interface:BusinessSituationTypeServiceFetch a singleSituationTemplateentity using key fields.- Specified by:
getSituationTemplateByKeyin interfaceBusinessSituationTypeService- Parameters:
sitnDefTemplateID- Situation Standard Template IDConstraints: Not nullable, Maximum length: 32
- Returns:
- A fluent helper to fetch a single
SituationTemplateentity 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 theexecutemethod on the fluent helper object.
-
getAllSituationContextDefSchema
Deprecated.Description copied from interface:BusinessSituationTypeServiceFetch multipleSituationContextDefSchemaentities.- Specified by:
getAllSituationContextDefSchemain interfaceBusinessSituationTypeService- Returns:
- A fluent helper to fetch multiple
SituationContextDefSchemaentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSituationContextDefSchemaByKey
@Nonnull public SituationContextDefSchemaByKeyFluentHelper getSituationContextDefSchemaByKey(String sitnDefTemplateID, Integer sitnDataCntxtFormatVersion, Integer sitnDataCntxtSchemaVersion) Deprecated.Description copied from interface:BusinessSituationTypeServiceFetch a singleSituationContextDefSchemaentity using key fields.- Specified by:
getSituationContextDefSchemaByKeyin interfaceBusinessSituationTypeService- Parameters:
sitnDefTemplateID- Situation Standard Template IDConstraints: Not nullable, Maximum length: 32
sitnDataCntxtFormatVersion- Context Format VersionConstraints: Not nullable
sitnDataCntxtSchemaVersion- Schema Version of Data Context DefinitionConstraints: Not nullable
- Returns:
- A fluent helper to fetch a single
SituationContextDefSchemaentity 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 theexecutemethod on the fluent helper object.
-
getAllSituationContextDefText
Deprecated.Description copied from interface:BusinessSituationTypeServiceFetch multipleSituationContextDefTextentities.- Specified by:
getAllSituationContextDefTextin interfaceBusinessSituationTypeService- Returns:
- A fluent helper to fetch multiple
SituationContextDefTextentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSituationContextDefTextByKey
@Nonnull public SituationContextDefTextByKeyFluentHelper getSituationContextDefTextByKey(String sitnDefTemplateID, Integer sitnDataCntxtFormatVersion, Integer sitnDataCntxtSchemaVersion, String language) Deprecated.Description copied from interface:BusinessSituationTypeServiceFetch a singleSituationContextDefTextentity using key fields.- Specified by:
getSituationContextDefTextByKeyin interfaceBusinessSituationTypeService- Parameters:
sitnDefTemplateID- Situation Standard Template IDConstraints: Not nullable, Maximum length: 32
sitnDataCntxtFormatVersion- Context Format VersionConstraints: Not nullable
sitnDataCntxtSchemaVersion- Schema Version of Data Context DefinitionConstraints: Not nullable
language- Language KeyConstraints: Not nullable, Maximum length: 2
- Returns:
- A fluent helper to fetch a single
SituationContextDefTextentity 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 theexecutemethod on the fluent helper object.
-