com.sap.cloud.sdk.s4hana.connectivity.rfc

Class BapiQuery

java.lang.Object

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

com.sap.cloud.sdk.s4hana.connectivity.rfc.AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

com.sap.cloud.sdk.s4hana.connectivity.rfc.BapiQuery

public class BapiQuery
extends AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Class representing a query calling a Business API (BAPI) in an ERP system.

Use the class RfcQuery to call remote-enabled function modules (RFC modules).

The signature of BAPIs consists of importing, exporting, and tables parameters.

From the perspective of the BAPI caller, input data is considered as exporting, output data is considered as importing and tables parameters can be used for both directions. The methods of this class are named following the caller's perspective.

From the perspective of the BAPI, importing means input data, exporting means output data, and tables parameters can be used for both directions.

Example:
Calling a BAPI with one importing parameter (from BAPI perspective) requires to utilize the method withExporting(String, String). Consider all existing variants of this method depending on the Java data type of the parameter, e.g. use withExporting(String, String, String) to pass a String object.

The data type (i.e. the data dictionary object) of importing and exporting parameters (regardless of the perspective) can either be a data element, a structure, or a table type.

• Use withExporting(String, String) and its data type dependent variants to supply an exporting BAPI parameter reflected by a data element.
• Use withExportingFields(String, String, Fields) to supply an exporting BAPI parameter reflected by a structure.
• Use withExportingTable(String, String) to supply an exporting BAPI parameter reflected by a table type.

After calling execute(ErpConfigContext) use the class BapiQueryResult to access the results of the BAPI call (e.g. the exporting parameters from the BAPI perspective respectively the importing parameters from the caller's perspective).

Field Summary

Fields inherited from class com.sap.cloud.sdk.s4hana.connectivity.rfc.AbstractRemoteFunctionQuery

commitStrategy, constructedByMethod, functionName, remoteFunctionQueryErrorHandler

Constructor Summary

Constructors

Constructor and Description
BapiQuery(String functionName) Constructs a synchronous BAPI query for which the result will be committed.
BapiQuery(String functionName, boolean commit) Constructs a BAPI query.
BapiQuery(String functionName, CommitStrategy commitStrategy) Constructs a BAPI query.

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
BapiQueryResult	execute(ErpConfigContext configContext)
int	hashCode()
BapiQuery	ignoringErrors() Specifies to invoke a RemoteFunctionQueryErrorHandler after the query execution which does not inspect the BapiQueryResult and, therefore, does not throw a RemoteFunctionException.
protected BapiQuery	instance() Convenience method that returns the current instance.
BapiQuery	propagatingErrorsAsExceptions() Specifies to invoke a RemoteFunctionQueryErrorHandler after the query execution which inspects the BapiQueryResult and throws a RemoteFunctionException or one of its more-specific exceptions depending on the returned error messages of the query.
String	toString()
BapiQuery	withErrorHandler(RemoteFunctionQueryErrorHandler remoteFunctionQueryErrorHandler) Specifies to invoke the provided RemoteFunctionQueryErrorHandler after the query has been executed.
BapiQuery	withExporting(String name, String dataType) Adds an exporting parameter reflected by a data element.
BapiQuery	withExporting(String name, String dataType, BigDecimal value) Adds an exporting BigDecimal parameter reflected by a data element.
BapiQuery	withExporting(String name, String dataType, BigInteger value) Adds an exporting BigInteger parameter reflected by a data element.
BapiQuery	withExporting(String name, String dataType, Boolean value) Adds an exporting Boolean parameter reflected by a data element.
BapiQuery	withExporting(String name, String dataType, Byte value) Adds an exporting Byte parameter reflected by a data element.
BapiQuery	withExporting(String name, String dataType, Character value) Adds an exporting Character parameter reflected by a data element.
BapiQuery	withExporting(String name, String dataType, Double value) Adds an exporting Double parameter reflected by a data element.
BapiQuery	withExporting(String name, String dataType, Float value) Adds an exporting Float parameter reflected by a data element.
BapiQuery	withExporting(String name, String dataType, Integer value) Adds an exporting Integer parameter reflected by a data element.
BapiQuery	withExporting(String name, String dataType, LocalDate value) Adds an exporting LocalDate parameter reflected by a data element.
BapiQuery	withExporting(String name, String dataType, Locale value) Adds an exporting Locale parameter reflected by a data element.
BapiQuery	withExporting(String name, String dataType, LocalTime value) Adds an exporting LocalTime parameter reflected by a data element.
BapiQuery	withExporting(String name, String dataType, Long value) Adds an exporting Long parameter reflected by a data element.
BapiQuery	withExporting(String name, String dataType, Short value) Adds an exporting Short parameter reflected by a data element.
BapiQuery	withExporting(String name, String dataType, String value) Adds an exporting String parameter reflected by a data element.
<T extends ErpType<T>> BapiQuery	withExporting(String name, String dataType, T value) Adds an exporting parameter reflected by a data element.
<T> BapiQuery	withExporting(String name, String dataType, T value, ErpTypeConverter<T> typeConverter) Adds an exporting parameter reflected by a data element.
BapiQuery	withExporting(String name, String dataType, Year value) Adds an exporting Year parameter.
ParameterFields<BapiQuery>	withExportingFields(String name, String dataType) Adds an exporting parameter reflected by a structure.
BapiQuery	withExportingFields(String name, String dataType, Fields fields) Adds an exporting parameter reflected by a structure.
Table<BapiQuery>	withExportingTable(String name, String dataType) Adds an exporting parameter reflected by a table type.
BapiQuery	withImporting(String name, String dataType) Adds an importing parameter reflected by a data element.
BapiQuery	withImporting(String name, String dataType, BigDecimal value) Adds a importing BigDecimal parameter reflected by a data element.
BapiQuery	withImporting(String name, String dataType, BigInteger value) Adds a importing BigInteger parameter reflected by a data element.
BapiQuery	withImporting(String name, String dataType, Boolean value) Adds a importing Boolean parameter reflected by a data element.
BapiQuery	withImporting(String name, String dataType, Byte value) Adds a importing Byte parameter reflected by a data element.
BapiQuery	withImporting(String name, String dataType, Character value) Adds a importing Character parameter reflected by a data element.
BapiQuery	withImporting(String name, String dataType, Double value) Adds a importing Double parameter reflected by a data element.
BapiQuery	withImporting(String name, String dataType, Float value) Adds a importing Float parameter reflected by a data element.
BapiQuery	withImporting(String name, String dataType, Integer value) Adds a importing Integer parameter reflected by a data element.
BapiQuery	withImporting(String name, String dataType, LocalDate value) Adds a importing LocalDate parameter reflected by a data element.
BapiQuery	withImporting(String name, String dataType, Locale value) Adds a importing Locale parameter reflected by a data element.
BapiQuery	withImporting(String name, String dataType, LocalTime value) Adds a importing LocalTime parameter reflected by a data element.
BapiQuery	withImporting(String name, String dataType, Long value) Adds a importing Long parameter reflected by a data element.
BapiQuery	withImporting(String name, String dataType, Short value) Adds a importing Short parameter reflected by a data element.
BapiQuery	withImporting(String name, String dataType, String value) Adds a importing String parameter reflected by a data element.
<T extends ErpType<T>> BapiQuery	withImporting(String name, String dataType, T value) Adds an importing parameter reflected by a data element.
<T> BapiQuery	withImporting(String name, String dataType, T value, ErpTypeConverter<T> typeConverter) Adds an importing parameter reflected by a data element.
BapiQuery	withImporting(String name, String dataType, Year value) Adds a importing Year parameter reflected by a data element.
BapiQuery	withImportingAsReturn(String dataType) Adds an importing parameter as a return parameter with the name defined by AbstractRemoteFunctionQuery.RETURN_PARAMETER.
BapiQuery	withImportingAsReturn(String name, String dataType) Adds an importing parameter as a return parameter.
ParameterFields<BapiQuery>	withImportingFields(String name, String dataType) Adds an importing parameter reflected by a structure.
BapiQuery	withImportingFields(String name, String dataType, Fields fields) Adds an importing parameter reflected by a structure.
Table<BapiQuery>	withImportingTable(String name, String dataType) Adds an importing parameter reflected by a table type.
Table<BapiQuery>	withTable(String name, String dataType) Adds a table parameter.
BapiQuery	withTableAsReturn(String dataType) Adds a table parameter as a return parameter with the name defined by AbstractRemoteFunctionQuery.RETURN_PARAMETER.
BapiQuery	withTableAsReturn(String name, String dataType) Adds a table parameter as a return parameter.
BapiQuery	withTypeConverters(ErpTypeConverter<?>... typeConverters) Delegates to AbstractRemoteFunctionQuery.withTypeConverters(Iterable).
BapiQuery	withTypeConverters(Iterable<ErpTypeConverter<?>> typeConverters) Registers the given ErpTypeConverters.

Methods inherited from class com.sap.cloud.sdk.s4hana.connectivity.rfc.AbstractRemoteFunctionQuery

doCommit, getCommitStrategy, getConstructedByMethod, getFunctionName, getTypeConverters, isPerformingTransactionalCommit, newParameter, newParameterWithValue, newParameterWithValueList, newParameterWithValueList

Methods inherited from class com.sap.cloud.sdk.s4hana.connectivity.Query

execute, getCustomHttpHeaders, getHeaderParameters, getLongRunningRequestThreshold, getReadAccessData, getRequestId, getThis, setLongRunningRequestThreshold, withCustomHttpHeader, withCustomHttpHeader, withSameCustomHttpHeadersAs

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BapiQuery

public BapiQuery(String functionName)
          throws IllegalArgumentException

Constructs a synchronous BAPI query for which the result will be committed.

Parameters:

functionName - The name of the BAPI to be called.

Throws:

IllegalArgumentException - If the given function is not a valid BAPI, i.e., its name does not start with the prefix "BAPI".

BapiQuery

public BapiQuery(String functionName,
                 boolean commit)
          throws IllegalArgumentException

Constructs a BAPI query.

Parameters:

functionName - The name of the BAPI to be called.

commit - Decides whether to commit the result of the BAPI call. If the commit parameter is true, the transaction is executed synchronously by default. The transaction can also be executed asynchronously by using the constructor BapiQuery(String, CommitStrategy).

Throws:

IllegalArgumentException - If the given function is not a valid BAPI, i.e., its name does not start with the prefix "BAPI".

BapiQuery

public BapiQuery(String functionName,
                 @Nonnull
                 CommitStrategy commitStrategy)
          throws IllegalArgumentException

Constructs a BAPI query.

Parameters:

functionName - The name of the BAPI to be called.

commitStrategy - Decides on the CommitStrategy

Throws:

IllegalArgumentException - If the given function is not a valid BAPI, i.e., its name does not start with the prefix "BAPI". Or if the query commit strategy is not supported.

Method Detail

execute

@Nonnull
public BapiQueryResult execute(@Nonnull
                                        ErpConfigContext configContext)
                                 throws QuerySerializationException,
                                        QueryExecutionException,
                                        DestinationNotFoundException,
                                        DestinationAccessException

Specified by:

execute in class Query<BapiQuery,BapiQueryResult>

Throws:

QuerySerializationException

QueryExecutionException

DestinationNotFoundException

DestinationAccessException

instance

@Nonnull
protected BapiQuery instance()

Convenience method that returns the current instance.

Specified by:

instance in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Returns:

The current instance.

withTypeConverters

@Nonnull
public BapiQuery withTypeConverters(Iterable<ErpTypeConverter<?>> typeConverters)

Description copied from class: AbstractRemoteFunctionQuery

Registers the given ErpTypeConverters. Replaces existing converters for already existing types that have been added before.

Overrides:

withTypeConverters in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

withTypeConverters

@Nonnull
public BapiQuery withTypeConverters(ErpTypeConverter<?>... typeConverters)

Description copied from class: AbstractRemoteFunctionQuery

Delegates to AbstractRemoteFunctionQuery.withTypeConverters(Iterable).

Overrides:

withTypeConverters in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

withExporting

@Nonnull
public BapiQuery withExporting(String name,
                                        String dataType)

Adds an exporting parameter reflected by a data element.

Note: Exporting refers to the point of view of the caller. Thus, when a parameter is declared as importing on ABAP side, you have to specify it as exporting here.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withExporting

@Nonnull
public <T extends ErpType<T>> BapiQuery withExporting(String name,
                                                               String dataType,
                                                               T value)

Adds an exporting parameter reflected by a data element.

Note: Exporting refers to the point of view of the caller. Thus, when a parameter is declared as importing on ABAP side, you have to specify it as exporting here.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

value - The value of the parameter.

withExporting

@Nonnull
public <T> BapiQuery withExporting(String name,
                                            String dataType,
                                            T value,
                                            ErpTypeConverter<T> typeConverter)

Adds an exporting parameter reflected by a data element.

Note: Exporting refers to the point of view of the caller. Thus, when a parameter is declared as importing on ABAP side, you have to specify it as exporting here.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

value - The value of the parameter.

typeConverter - A type converter defining how to convert the type of the given value to its ERP representation.

withExporting

@Nonnull
public BapiQuery withExporting(String name,
                                        String dataType,
                                        Boolean value)

Adds an exporting Boolean parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withExporting(String, String, Object, ErpTypeConverter)

withExporting

@Nonnull
public BapiQuery withExporting(String name,
                                        String dataType,
                                        Byte value)

Adds an exporting Byte parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withExporting(String, String, Object, ErpTypeConverter)

withExporting

@Nonnull
public BapiQuery withExporting(String name,
                                        String dataType,
                                        Character value)

Adds an exporting Character parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withExporting(String, String, Object, ErpTypeConverter)

withExporting

@Nonnull
public BapiQuery withExporting(String name,
                                        String dataType,
                                        String value)

Adds an exporting String parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withExporting(String, String, Object, ErpTypeConverter)

withExporting

@Nonnull
public BapiQuery withExporting(String name,
                                        String dataType,
                                        Short value)

Adds an exporting Short parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withExporting(String, String, Object, ErpTypeConverter)

withExporting

@Nonnull
public BapiQuery withExporting(String name,
                                        String dataType,
                                        Integer value)

Adds an exporting Integer parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withExporting(String, String, Object, ErpTypeConverter)

withExporting

@Nonnull
public BapiQuery withExporting(String name,
                                        String dataType,
                                        Long value)

Adds an exporting Long parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withExporting(String, String, Object, ErpTypeConverter)

withExporting

@Nonnull
public BapiQuery withExporting(String name,
                                        String dataType,
                                        Float value)

Adds an exporting Float parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withExporting(String, String, Object, ErpTypeConverter)

withExporting

@Nonnull
public BapiQuery withExporting(String name,
                                        String dataType,
                                        Double value)

Adds an exporting Double parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withExporting(String, String, Object, ErpTypeConverter)

withExporting

@Nonnull
public BapiQuery withExporting(String name,
                                        String dataType,
                                        BigInteger value)

Adds an exporting BigInteger parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withExporting(String, String, Object, ErpTypeConverter)

withExporting

@Nonnull
public BapiQuery withExporting(String name,
                                        String dataType,
                                        BigDecimal value)

Adds an exporting BigDecimal parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withExporting(String, String, Object, ErpTypeConverter)

withExporting

@Nonnull
public BapiQuery withExporting(String name,
                                        String dataType,
                                        Locale value)

Adds an exporting Locale parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withExporting(String, String, Object, ErpTypeConverter)

withExporting

@Nonnull
public BapiQuery withExporting(String name,
                                        String dataType,
                                        Year value)

Adds an exporting Year parameter. reflected by a data element

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withExporting(String, String, Object, ErpTypeConverter)

withExporting

@Nonnull
public BapiQuery withExporting(String name,
                                        String dataType,
                                        LocalDate value)

Adds an exporting LocalDate parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withExporting(String, String, Object, ErpTypeConverter)

withExporting

@Nonnull
public BapiQuery withExporting(String name,
                                        String dataType,
                                        LocalTime value)

Adds an exporting LocalTime parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withExporting(String, String, Object, ErpTypeConverter)

withExportingFields

@Nonnull
public ParameterFields<BapiQuery> withExportingFields(String name,
                                                               String dataType)

Adds an exporting parameter reflected by a structure.

Note: Exporting refers to the point of view of the caller. Thus, when a parameter is declared as importing on ABAP side, you have to specify it as exporting here.

Overrides:

withExportingFields in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withExportingFields

@Nonnull
public BapiQuery withExportingFields(String name,
                                              String dataType,
                                              Fields fields)

Adds an exporting parameter reflected by a structure.

Note: Exporting refers to the point of view of the caller. Thus, when a parameter is declared as importing on ABAP side, you have to specify it as exporting here.

Overrides:

withExportingFields in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

fields - The exporting fields.

withExportingTable

@Nonnull
public Table<BapiQuery> withExportingTable(String name,
                                                    String dataType)

Adds an exporting parameter reflected by a table type.

Note: Exporting refers to the point of view of the caller. Thus, when a parameter is declared as importing on ABAP side, you have to specify it as exporting here.

Overrides:

withExportingTable in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withImporting

@Nonnull
public BapiQuery withImporting(String name,
                                        String dataType)

Adds an importing parameter reflected by a data element.

Note that importing is related to the point of view of the caller. Thus, when a parameter is declared as exporting on ABAP side, you have to specify it as importing here.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withImporting

@Nonnull
public <T extends ErpType<T>> BapiQuery withImporting(String name,
                                                               String dataType,
                                                               T value)

Adds an importing parameter reflected by a data element.

Note that importing is related to the point of view of the caller. Thus, when a parameter is declared as exporting on ABAP side, you have to specify it as importing here.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

value - The value of the parameter.

withImporting

@Nonnull
public <T> BapiQuery withImporting(String name,
                                            String dataType,
                                            T value,
                                            ErpTypeConverter<T> typeConverter)

Adds an importing parameter reflected by a data element.

Note that importing is related to the point of view of the caller. Thus, when a parameter is declared as exporting on ABAP side, you have to specify it as importing here.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

value - The value of the parameter.

typeConverter - A type converter defining how to convert the type of the given value to its ERP representation.

withImporting

@Nonnull
public BapiQuery withImporting(String name,
                                        String dataType,
                                        Boolean value)

Adds a importing Boolean parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withImporting(String, String, Object, ErpTypeConverter)

withImporting

@Nonnull
public BapiQuery withImporting(String name,
                                        String dataType,
                                        Byte value)

Adds a importing Byte parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withImporting(String, String, Object, ErpTypeConverter)

withImporting

@Nonnull
public BapiQuery withImporting(String name,
                                        String dataType,
                                        Character value)

Adds a importing Character parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withImporting(String, String, Object, ErpTypeConverter)

withImporting

@Nonnull
public BapiQuery withImporting(String name,
                                        String dataType,
                                        String value)

Adds a importing String parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withImporting(String, String, Object, ErpTypeConverter)

withImporting

@Nonnull
public BapiQuery withImporting(String name,
                                        String dataType,
                                        Short value)

Adds a importing Short parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withImporting(String, String, Object, ErpTypeConverter)

withImporting

@Nonnull
public BapiQuery withImporting(String name,
                                        String dataType,
                                        Integer value)

Adds a importing Integer parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withImporting(String, String, Object, ErpTypeConverter)

withImporting

@Nonnull
public BapiQuery withImporting(String name,
                                        String dataType,
                                        Long value)

Adds a importing Long parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withImporting(String, String, Object, ErpTypeConverter)

withImporting

@Nonnull
public BapiQuery withImporting(String name,
                                        String dataType,
                                        Float value)

Adds a importing Float parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withImporting(String, String, Object, ErpTypeConverter)

withImporting

@Nonnull
public BapiQuery withImporting(String name,
                                        String dataType,
                                        Double value)

Adds a importing Double parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withImporting(String, String, Object, ErpTypeConverter)

withImporting

@Nonnull
public BapiQuery withImporting(String name,
                                        String dataType,
                                        BigInteger value)

Adds a importing BigInteger parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withImporting(String, String, Object, ErpTypeConverter)

withImporting

@Nonnull
public BapiQuery withImporting(String name,
                                        String dataType,
                                        BigDecimal value)

Adds a importing BigDecimal parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withImporting(String, String, Object, ErpTypeConverter)

withImporting

@Nonnull
public BapiQuery withImporting(String name,
                                        String dataType,
                                        Locale value)

Adds a importing Locale parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withImporting(String, String, Object, ErpTypeConverter)

withImporting

@Nonnull
public BapiQuery withImporting(String name,
                                        String dataType,
                                        Year value)

Adds a importing Year parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withImporting(String, String, Object, ErpTypeConverter)

withImporting

@Nonnull
public BapiQuery withImporting(String name,
                                        String dataType,
                                        LocalDate value)

Adds a importing LocalDate parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withImporting(String, String, Object, ErpTypeConverter)

withImporting

@Nonnull
public BapiQuery withImporting(String name,
                                        String dataType,
                                        LocalTime value)

Adds a importing LocalTime parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

See Also:

AbstractRemoteFunctionQuery.withImporting(String, String, Object, ErpTypeConverter)

withImportingFields

@Nonnull
public ParameterFields<BapiQuery> withImportingFields(String name,
                                                               String dataType)

Adds an importing parameter reflected by a structure.

Note that importing is related to the point of view of the caller. Thus, when a parameter is declared as exporting on ABAP side, you have to specify it as importing here.

Overrides:

withImportingFields in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withImportingFields

@Nonnull
public BapiQuery withImportingFields(String name,
                                              String dataType,
                                              Fields fields)

Adds an importing parameter reflected by a structure.

Note that importing is related to the point of view of the caller. Thus, when a parameter is declared as exporting on ABAP side, you have to specify it as importing here.

Overrides:

withImportingFields in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

fields - The importing fields.

withImportingTable

@Nonnull
public Table<BapiQuery> withImportingTable(String name,
                                                    String dataType)

Adds an importing parameter reflected by a table type.

Note that importing is related to the point of view of the caller. Thus, when a parameter is declared as exporting on ABAP side, you have to specify it as importing here.

Overrides:

withImportingTable in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withImportingAsReturn

@Nonnull
public BapiQuery withImportingAsReturn(String dataType)

Adds an importing parameter as a return parameter with the name defined by AbstractRemoteFunctionQuery.RETURN_PARAMETER.

Note that return parameters refer to parameters for which return messages will be parsed and translated to RemoteFunctionMessages.

Overrides:

withImportingAsReturn in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

dataType - The ABAP data type of the parameter.

withImportingAsReturn

@Nonnull
public BapiQuery withImportingAsReturn(String name,
                                                String dataType)

Adds an importing parameter as a return parameter.

Note that return parameters refer to parameters for which return messages will be parsed and translated to RemoteFunctionMessages.

Overrides:

withImportingAsReturn in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withTable

@Nonnull
public Table<BapiQuery> withTable(String name,
                                           String dataType)

Adds a table parameter.

Overrides:

withTable in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withTableAsReturn

@Nonnull
public BapiQuery withTableAsReturn(String dataType)

Adds a table parameter as a return parameter with the name defined by AbstractRemoteFunctionQuery.RETURN_PARAMETER.

Note that return parameters refer to parameters for which return messages will be parsed and translated to RemoteFunctionMessages.

Overrides:

withTableAsReturn in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

dataType - The ABAP data type of the parameter.

withTableAsReturn

@Nonnull
public BapiQuery withTableAsReturn(String name,
                                            String dataType)

Adds a table parameter as a return parameter.

Note that return parameters refer to parameters for which return messages will be parsed and translated to RemoteFunctionMessages.

Overrides:

withTableAsReturn in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withErrorHandler

@Nonnull
public BapiQuery withErrorHandler(@Nonnull
                                           RemoteFunctionQueryErrorHandler remoteFunctionQueryErrorHandler)

Specifies to invoke the provided RemoteFunctionQueryErrorHandler after the query has been executed.

Overrides:

withErrorHandler in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Parameters:

remoteFunctionQueryErrorHandler - The result handler to invoke after query execution

Returns:

This query to allow for fluent formulation

ignoringErrors

@Nonnull
public BapiQuery ignoringErrors()

Specifies to invoke a RemoteFunctionQueryErrorHandler after the query execution which does not inspect the BapiQueryResult and, therefore, does not throw a RemoteFunctionException.

Overrides:

ignoringErrors in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Returns:

This query to allow for fluent formulation

propagatingErrorsAsExceptions

@Nonnull
public BapiQuery propagatingErrorsAsExceptions()

Specifies to invoke a RemoteFunctionQueryErrorHandler after the query execution which inspects the BapiQueryResult and throws a RemoteFunctionException or one of its more-specific exceptions depending on the returned error messages of the query.

Overrides:

propagatingErrorsAsExceptions in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

Returns:

This query to allow for fluent formulation

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>

toString

public String toString()

Overrides:

toString in class AbstractRemoteFunctionQuery<BapiQuery,BapiQueryResult>