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

Class DefaultBusinessSituationTypeService

java.lang.Object

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

All Implemented Interfaces:

BatchService<BusinessSituationTypeServiceBatch>, BusinessSituationTypeService

@Named(value="com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.DefaultBusinessSituationTypeService")
public class DefaultBusinessSituationTypeService
extends Object
implements 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. .

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 inherited from interface com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.BusinessSituationTypeService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultBusinessSituationTypeService() Creates a service using BusinessSituationTypeService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultBusinessSituationTypeServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultBusinessSituationTypeService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultBusinessSituationTypeService

public DefaultBusinessSituationTypeService()

Creates a service using BusinessSituationTypeService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultBusinessSituationTypeService withServicePath(@Nonnull
                                                                    String servicePath)

Description copied from interface: BusinessSituationTypeService

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Specified by:

withServicePath in interface BusinessSituationTypeService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultBusinessSituationTypeServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<BusinessSituationTypeServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllSituationAction

@Nonnull
public SituationActionFluentHelper getAllSituationAction()

Description copied from interface: BusinessSituationTypeService

Fetch multiple SituationAction entities.

Specified by:

getAllSituationAction in interface BusinessSituationTypeService

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
public SituationActionByKeyFluentHelper getSituationActionByKey(String sitnDefTemplateID,
                                                                         String sitnActionID)

Description copied from interface: BusinessSituationTypeService

Fetch a single SituationAction entity using key fields.

Specified by:

getSituationActionByKey in interface BusinessSituationTypeService

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
public SituationActionTextFluentHelper getAllSituationActionText()

Description copied from interface: BusinessSituationTypeService

Fetch multiple SituationActionText entities.

Specified by:

getAllSituationActionText in interface BusinessSituationTypeService

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
public SituationActionTextByKeyFluentHelper getSituationActionTextByKey(String sitnActionID,
                                                                                 String language)

Description copied from interface: BusinessSituationTypeService

Fetch a single SituationActionText entity using key fields.

Specified by:

getSituationActionTextByKey in interface BusinessSituationTypeService

Parameters:

sitnActionID - Action ID

Constraints: Not nullable, Maximum length: 32

language - Language Key

Constraints: Not nullable, Maximum length: 2

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
public SituationTemplateTextFluentHelper getAllSituationTemplateText()

Description copied from interface: BusinessSituationTypeService

Fetch multiple SituationTemplateText entities.

Specified by:

getAllSituationTemplateText in interface BusinessSituationTypeService

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
public SituationTemplateTextByKeyFluentHelper getSituationTemplateTextByKey(String sitnDefTemplateID,
                                                                                     String language)

Description copied from interface: BusinessSituationTypeService

Fetch a single SituationTemplateText entity using key fields.

Specified by:

getSituationTemplateTextByKey in interface BusinessSituationTypeService

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
public SituationTypeFluentHelper getAllSituationType()

Description copied from interface: BusinessSituationTypeService

Fetch multiple SituationType entities.

Specified by:

getAllSituationType in interface BusinessSituationTypeService

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
public SituationTypeByKeyFluentHelper getSituationTypeByKey(String sitnDefinitionID)

Description copied from interface: BusinessSituationTypeService

Fetch a single SituationType entity using key fields.

Specified by:

getSituationTypeByKey in interface BusinessSituationTypeService

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
public SituationTypeTextFluentHelper getAllSituationTypeText()

Description copied from interface: BusinessSituationTypeService

Fetch multiple SituationTypeText entities.

Specified by:

getAllSituationTypeText in interface BusinessSituationTypeService

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
public SituationTypeTextByKeyFluentHelper getSituationTypeTextByKey(String sitnDefinitionID,
                                                                             String language)

Description copied from interface: BusinessSituationTypeService

Fetch a single SituationTypeText entity using key fields.

Specified by:

getSituationTypeTextByKey in interface BusinessSituationTypeService

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
public SituationTemplateFluentHelper getAllSituationTemplate()

Description copied from interface: BusinessSituationTypeService

Fetch multiple SituationTemplate entities.

Specified by:

getAllSituationTemplate in interface BusinessSituationTypeService

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
public SituationTemplateByKeyFluentHelper getSituationTemplateByKey(String sitnDefTemplateID)

Description copied from interface: BusinessSituationTypeService

Fetch a single SituationTemplate entity using key fields.

Specified by:

getSituationTemplateByKey in interface BusinessSituationTypeService

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.