com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services

Interface BusinessSituationTypeService

All Superinterfaces:

BatchService<BusinessSituationTypeServiceBatch>

All Known Implementing Classes:

DefaultBusinessSituationTypeService

public interface BusinessSituationTypeService
extends BatchService<BusinessSituationTypeServiceBatch>

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. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_BUS_SITN_MSTRDATA_SRV_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Business Situation Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
SituationActionFluentHelper	getAllSituationAction() Fetch multiple SituationAction entities.
SituationActionTextFluentHelper	getAllSituationActionText() Fetch multiple SituationActionText entities.
SituationTemplateFluentHelper	getAllSituationTemplate() Fetch multiple SituationTemplate entities.
SituationTemplateTextFluentHelper	getAllSituationTemplateText() Fetch multiple SituationTemplateText entities.
SituationTypeFluentHelper	getAllSituationType() Fetch multiple SituationType entities.
SituationTypeTextFluentHelper	getAllSituationTypeText() Fetch multiple SituationTypeText entities.
SituationActionByKeyFluentHelper	getSituationActionByKey(String sitnDefTemplateID, String sitnActionID) Fetch a single SituationAction entity using key fields.
SituationActionTextByKeyFluentHelper	getSituationActionTextByKey(String sitnActionID, String language) Fetch a single SituationActionText entity using key fields.
SituationTemplateByKeyFluentHelper	getSituationTemplateByKey(String sitnDefTemplateID) Fetch a single SituationTemplate entity using key fields.
SituationTemplateTextByKeyFluentHelper	getSituationTemplateTextByKey(String sitnDefTemplateID, String language) Fetch a single SituationTemplateText entity using key fields.
SituationTypeByKeyFluentHelper	getSituationTypeByKey(String sitnDefinitionID) Fetch a single SituationType entity using key fields.
SituationTypeTextByKeyFluentHelper	getSituationTypeTextByKey(String sitnDefinitionID, String language) Fetch a single SituationTypeText entity using key fields.
BusinessSituationTypeService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
BusinessSituationTypeService withServicePath(@Nonnull
                                                      String servicePath)

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()

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)

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()

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)

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()

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)

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()

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)

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()

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)

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()

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)

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.