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

Class DefaultBusinessSituationTypeV2Service

java.lang.Object

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

All Implemented Interfaces:

BatchService<BusinessSituationTypeV2ServiceBatch>, BusinessSituationTypeV2Service

@Named("com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultBusinessSituationTypeV2Service")
@Deprecated
public class DefaultBusinessSituationTypeV2Service
extends Object
implements BusinessSituationTypeV2Service

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 Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.BusinessSituationTypeV2Service

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor	Description
DefaultBusinessSituationTypeV2Service()	Deprecated. Creates a service using BusinessSituationTypeV2Service.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method	Description
DefaultBusinessSituationTypeV2ServiceBatch	batch()	Deprecated.
SituationActionFluentHelper	getAllSituationAction()	Deprecated. Fetch multiple SituationAction entities.
SituationActionTextFluentHelper	getAllSituationActionText()	Deprecated. Fetch multiple SituationActionText entities.
SituationContextDefSchemaFluentHelper	getAllSituationContextDefSchema()	Deprecated. Fetch multiple SituationContextDefSchema entities.
SituationContextDefTextFluentHelper	getAllSituationContextDefText()	Deprecated. Fetch multiple SituationContextDefText entities.
SituationTemplateFluentHelper	getAllSituationTemplate()	Deprecated. Fetch multiple SituationTemplate entities.
SituationTemplateTextFluentHelper	getAllSituationTemplateText()	Deprecated. Fetch multiple SituationTemplateText entities.
SituationTypeFluentHelper	getAllSituationType()	Deprecated. Fetch multiple SituationType entities.
SituationTypeTextFluentHelper	getAllSituationTypeText()	Deprecated. Fetch multiple SituationTypeText entities.
SituationActionByKeyFluentHelper	getSituationActionByKey(String sitnDefTemplateID, String sitnActionID)	Deprecated. Fetch a single SituationAction entity using key fields.
SituationActionTextByKeyFluentHelper	getSituationActionTextByKey(String sitnActionID, String language)	Deprecated. Fetch a single SituationActionText entity using key fields.
SituationContextDefSchemaByKeyFluentHelper	getSituationContextDefSchemaByKey(String sitnDefTemplateID, Integer sitnDataCntxtVersion, Integer sitnDataCntxtFormatVersion, Integer sitnDataCntxtSchemaVersion)	Deprecated. Fetch a single SituationContextDefSchema entity using key fields.
SituationContextDefTextByKeyFluentHelper	getSituationContextDefTextByKey(String sitnDefTemplateID, Integer sitnDataCntxtVersion, Integer sitnDataCntxtFormatVersion, Integer sitnDataCntxtSchemaVersion, String language)	Deprecated. Fetch a single SituationContextDefText entity using key fields.
SituationTemplateByKeyFluentHelper	getSituationTemplateByKey(String sitnDefTemplateID)	Deprecated. Fetch a single SituationTemplate entity using key fields.
SituationTemplateTextByKeyFluentHelper	getSituationTemplateTextByKey(String sitnDefTemplateID, String language)	Deprecated. Fetch a single SituationTemplateText entity using key fields.
SituationTypeByKeyFluentHelper	getSituationTypeByKey(String sitnDefinitionID)	Deprecated. Fetch a single SituationType entity using key fields.
SituationTypeTextByKeyFluentHelper	getSituationTypeTextByKey(String sitnDefinitionID, String language)	Deprecated. Fetch a single SituationTypeText entity using key fields.
DefaultBusinessSituationTypeV2Service	withServicePath(String servicePath)	Deprecated. 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 Details

DefaultBusinessSituationTypeV2Service

public DefaultBusinessSituationTypeV2Service()

Deprecated.

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

Method Details

withServicePath

@Nonnull
public DefaultBusinessSituationTypeV2Service withServicePath(@Nonnull
 String servicePath)

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

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 BusinessSituationTypeV2Service

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultBusinessSituationTypeV2ServiceBatch batch()

Deprecated.

Specified by:

batch in interface BatchService<BusinessSituationTypeV2ServiceBatch>

getAllSituationAction

@Nonnull
public SituationActionFluentHelper getAllSituationAction()

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

Fetch multiple SituationAction entities.

Specified by:

getAllSituationAction in interface BusinessSituationTypeV2Service

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)

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

Fetch a single SituationAction entity using key fields.

Specified by:

getSituationActionByKey in interface BusinessSituationTypeV2Service

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

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

Fetch multiple SituationActionText entities.

Specified by:

getAllSituationActionText in interface BusinessSituationTypeV2Service

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)

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

Fetch a single SituationActionText entity using key fields.

Specified by:

getSituationActionTextByKey in interface BusinessSituationTypeV2Service

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

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

Fetch multiple SituationTemplateText entities.

Specified by:

getAllSituationTemplateText in interface BusinessSituationTypeV2Service

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)

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

Fetch a single SituationTemplateText entity using key fields.

Specified by:

getSituationTemplateTextByKey in interface BusinessSituationTypeV2Service

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

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

Fetch multiple SituationType entities.

Specified by:

getAllSituationType in interface BusinessSituationTypeV2Service

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)

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

Fetch a single SituationType entity using key fields.

Specified by:

getSituationTypeByKey in interface BusinessSituationTypeV2Service

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

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

Fetch multiple SituationTypeText entities.

Specified by:

getAllSituationTypeText in interface BusinessSituationTypeV2Service

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)

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

Fetch a single SituationTypeText entity using key fields.

Specified by:

getSituationTypeTextByKey in interface BusinessSituationTypeV2Service

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

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

Fetch multiple SituationTemplate entities.

Specified by:

getAllSituationTemplate in interface BusinessSituationTypeV2Service

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)

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

Fetch a single SituationTemplate entity using key fields.

Specified by:

getSituationTemplateByKey in interface BusinessSituationTypeV2Service

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
public SituationContextDefSchemaFluentHelper getAllSituationContextDefSchema()

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

Fetch multiple SituationContextDefSchema entities.

Specified by:

getAllSituationContextDefSchema in interface BusinessSituationTypeV2Service

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
public SituationContextDefSchemaByKeyFluentHelper getSituationContextDefSchemaByKey(String sitnDefTemplateID,
 Integer sitnDataCntxtVersion,
 Integer sitnDataCntxtFormatVersion,
 Integer sitnDataCntxtSchemaVersion)

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

Fetch a single SituationContextDefSchema entity using key fields.

Specified by:

getSituationContextDefSchemaByKey in interface BusinessSituationTypeV2Service

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
public SituationContextDefTextFluentHelper getAllSituationContextDefText()

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

Fetch multiple SituationContextDefText entities.

Specified by:

getAllSituationContextDefText in interface BusinessSituationTypeV2Service

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
public SituationContextDefTextByKeyFluentHelper getSituationContextDefTextByKey(String sitnDefTemplateID,
 Integer sitnDataCntxtVersion,
 Integer sitnDataCntxtFormatVersion,
 Integer sitnDataCntxtSchemaVersion,
 String language)

Deprecated.

Description copied from interface: BusinessSituationTypeV2Service

Fetch a single SituationContextDefText entity using key fields.

Specified by:

getSituationContextDefTextByKey in interface BusinessSituationTypeV2Service

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

language - Language Key

Constraints: Not nullable, Maximum length: 2

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.