com.sap.cloud.sdk.s4hana.connectivity

Class Query<QueryT extends Query<QueryT,QueryResultT>,QueryResultT extends QueryResult<QueryT,QueryResultT>>

java.lang.Object

com.sap.cloud.sdk.s4hana.connectivity.Query<QueryT,QueryResultT>

Direct Known Subclasses:

BapiQuery, InfoQuery, RfcQuery

public abstract class Query<QueryT extends Query<QueryT,QueryResultT>,QueryResultT extends QueryResult<QueryT,QueryResultT>>
extends Object

Common interface for ERP queries.

Method Summary

Modifier and Type	Method and Description
abstract QueryResultT	execute(ErpEndpoint erpEndpoint) Executes a given query against the given S/4HANA endpoint.
abstract String	getConstructedByMethod()
org.joda.time.Duration	getLongRunningRequestThreshold() Custom execution duration threshold indicating that the query is long running.
String	getReadAccessData()
long	getRequestId() Represents an identifier that allows to correlate queries between the Cloud cloudplatform and the ERP.
void	setLongRunningRequestThreshold(org.joda.time.Duration longRunningRequestThreshold) Custom execution duration threshold indicating that the query is long running.

Methods inherited from class java.lang.Object

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

Method Detail

getConstructedByMethod

public abstract String getConstructedByMethod()

Returns:

The method name that originally constructed this ERP query. This information is used for debugging.

getReadAccessData

@Nullable
public String getReadAccessData()

Returns:

A optional String representation of the data being access by this query. If present, an audit log entry is written using the given data.

execute

public abstract QueryResultT execute(ErpEndpoint erpEndpoint)
                              throws QuerySerializationException,
                                     QueryExecutionException,
                                     DestinationNotFoundException,
                                     DestinationAccessException

Executes a given query against the given S/4HANA endpoint.

Throws:

QuerySerializationException

QueryExecutionException

DestinationNotFoundException

DestinationAccessException

getRequestId

public long getRequestId()

Represents an identifier that allows to correlate queries between the Cloud cloudplatform and the ERP.

Important: The identifier does not provide any guarantees with respect to persistence across the application lifecycle. In particular, the identifier will be reset to 1 when restarting the application.

getLongRunningRequestThreshold

@Nullable
public org.joda.time.Duration getLongRunningRequestThreshold()

Custom execution duration threshold indicating that the query is long running.

setLongRunningRequestThreshold

public void setLongRunningRequestThreshold(@Nullable
                                           org.joda.time.Duration longRunningRequestThreshold)

Custom execution duration threshold indicating that the query is long running.