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

Class DefaultBusinessSituationService

java.lang.Object

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

All Implemented Interfaces:

BatchService<BusinessSituationServiceBatch>, BusinessSituationService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultBusinessSituationService")
public class DefaultBusinessSituationService
extends Object
implements BusinessSituationService

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:	API_BUSINESS_SITUATION_SRV
API Version:	1
Communication Scenario:	Business Situation Integration (SAP_COM_0345)
Scope Items:	Situation Handling (31N)
Authentication Methods:	Basic, x509
Business Object:	BusinessSituation

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultBusinessSituationService() Creates a service using BusinessSituationService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultBusinessSituationServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
SitnDataContextFluentHelper	getAllSitnDataContext() Fetch multiple SitnDataContext entities.
SitnInstanceFluentHelper	getAllSitnInstance() Fetch multiple SitnInstance entities.
SitnDataContextByKeyFluentHelper	getSitnDataContextByKey(String sitnDataContextID) Fetch a single SitnDataContext entity using key fields.
SitnInstanceByKeyFluentHelper	getSitnInstanceByKey(String sitnInstanceID) Fetch a single SitnInstance entity using key fields.
SendActionStatusFluentHelper	sendActionStatus(String sitnActionInstanceID, String sitnActionID, String sitnActionStatus, String sitnInstanceID, String sitnInstceTargetStatus) Creates a fluent helper for the SendActionStatus OData function import.
DefaultBusinessSituationService	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

DefaultBusinessSituationService

public DefaultBusinessSituationService()

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

Method Detail

withServicePath

@Nonnull
public DefaultBusinessSituationService withServicePath(@Nonnull
                                                                String servicePath)

Description copied from interface: BusinessSituationService

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 BusinessSituationService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultBusinessSituationServiceBatch batch()

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

Specified by:

batch in interface BatchService<BusinessSituationServiceBatch>

Returns:

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

getAllSitnDataContext

@Nonnull
public SitnDataContextFluentHelper getAllSitnDataContext()

Description copied from interface: BusinessSituationService

Fetch multiple SitnDataContext entities.

Specified by:

getAllSitnDataContext in interface BusinessSituationService

Returns:

A fluent helper to fetch multiple SitnDataContext 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.

getSitnDataContextByKey

@Nonnull
public SitnDataContextByKeyFluentHelper getSitnDataContextByKey(String sitnDataContextID)

Description copied from interface: BusinessSituationService

Fetch a single SitnDataContext entity using key fields.

Specified by:

getSitnDataContextByKey in interface BusinessSituationService

Parameters:

sitnDataContextID - Data Context ID

Constraints: Not nullable, Maximum length: 32

Returns:

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

getAllSitnInstance

@Nonnull
public SitnInstanceFluentHelper getAllSitnInstance()

Description copied from interface: BusinessSituationService

Fetch multiple SitnInstance entities.

Specified by:

getAllSitnInstance in interface BusinessSituationService

Returns:

A fluent helper to fetch multiple SitnInstance 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.

getSitnInstanceByKey

@Nonnull
public SitnInstanceByKeyFluentHelper getSitnInstanceByKey(String sitnInstanceID)

Description copied from interface: BusinessSituationService

Fetch a single SitnInstance entity using key fields.

Specified by:

getSitnInstanceByKey in interface BusinessSituationService

Parameters:

sitnInstanceID - Instance ID

Constraints: Not nullable, Maximum length: 32

Returns:

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

sendActionStatus

@Nonnull
public SendActionStatusFluentHelper sendActionStatus(@Nonnull
                                                              String sitnActionInstanceID,
                                                              @Nonnull
                                                              String sitnActionID,
                                                              @Nonnull
                                                              String sitnActionStatus,
                                                              @Nonnull
                                                              String sitnInstanceID,
                                                              @Nonnull
                                                              String sitnInstceTargetStatus)

Description copied from interface: BusinessSituationService

Creates a fluent helper for the SendActionStatus OData function import.

Specified by:

sendActionStatus in interface BusinessSituationService

Parameters:

sitnActionInstanceID - Unique action instance ID generated by the service client

Constraints: Not nullable, Maximum length: 36

Original parameter name from the Odata EDM: SitnActionInstanceID

sitnActionID - ActionID defined by situation template, NO_ACTION or UNKNOWN

Constraints: Not nullable, Maximum length: 32

Original parameter name from the Odata EDM: SitnActionID

sitnActionStatus - Action status: SUCCESS or FAILURE

Constraints: Not nullable, Maximum length: 7

Original parameter name from the Odata EDM: SitnActionStatus

sitnInstanceID - Situation instance ID for which the action was performed

Constraints: Not nullable, Maximum length: 32

Original parameter name from the Odata EDM: SitnInstanceID

sitnInstceTargetStatus - Target instance status: OP(Open) RE(Resolved) UN(Unchanged)

Constraints: Not nullable, Maximum length: 2

Original parameter name from the Odata EDM: SitnInstceTargetStatus

Returns:

A fluent helper object that will execute the SendActionStatus OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.