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

Class BapiRequest

java.lang.Object

com.sap.cloud.sdk.s4hana.connectivity.Request<RequestT,RequestResultT>

com.sap.cloud.sdk.s4hana.connectivity.rfc.AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

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

public class BapiRequest
extends AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

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

Use the class RfmRequest 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(Destination) use the class BapiRequestResult 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.AbstractRemoteFunctionRequest

commitStrategy, constructedByMethod, functionName, remoteFunctionRequestErrorHandler

Constructor Summary

Constructors

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

Method Summary

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

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

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

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

getCustomHttpHeaders, getLongRunningRequestThreshold, getReadAccessData, getRequestId, getThis, setLongRunningRequestThreshold, withHeader, withHeader, withSameCustomHttpHeadersAs

Methods inherited from class java.lang.Object

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

Constructor Detail

BapiRequest

public BapiRequest(String functionName)
            throws IllegalArgumentException

Constructs a synchronous BAPI request 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".

BapiRequest

public BapiRequest(String functionName,
                   boolean commit)
            throws IllegalArgumentException

Constructs a BAPI request.

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 BapiRequest(String, CommitStrategy).

Throws:

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

BapiRequest

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

Constructs a BAPI request.

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 request commit strategy is not supported.

Method Detail

execute

@Nonnull
public BapiRequestResult execute(@Nonnull
                                          Destination destination)
                                   throws RequestSerializationException,
                                          RequestExecutionException,
                                          DestinationNotFoundException,
                                          DestinationAccessException

Executes a given request using the given Destination.

Specified by:

execute in class Request<BapiRequest,BapiRequestResult>

Parameters:

destination - The Destination to be used for request execution.

Throws:

RequestSerializationException - If there is an issue while serializing the request.

RequestExecutionException - If there is an issue while executing the request.

DestinationNotFoundException - If no destination with the name specified in the Destination can be found.

DestinationAccessException - If there is an issue while accessing destination information.

instance

@Nonnull
protected BapiRequest instance()

Convenience method that returns the current instance.

Specified by:

instance in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Returns:

The current instance.

withTypeConverters

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

Description copied from class: AbstractRemoteFunctionRequest

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

Overrides:

withTypeConverters in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

withTypeConverters

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

Description copied from class: AbstractRemoteFunctionRequest

Delegates to AbstractRemoteFunctionRequest.withTypeConverters(Iterable).

Overrides:

withTypeConverters in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

withExporting

@Nonnull
public BapiRequest 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 AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withExporting

@Nonnull
public <T extends ErpType<T>> BapiRequest 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 AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

value - The value of the parameter.

withExporting

@Nonnull
public <T> BapiRequest 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 AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

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 BapiRequest withExporting(String name,
                                          String dataType,
                                          Boolean value)

Adds an exporting Boolean parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withExporting

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

Adds an exporting Byte parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withExporting

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

Adds an exporting Character parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withExporting

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

Adds an exporting String parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withExporting

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

Adds an exporting Short parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withExporting

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

Adds an exporting Integer parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withExporting

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

Adds an exporting Long parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withExporting

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

Adds an exporting Float parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withExporting

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

Adds an exporting Double parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withExporting

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

Adds an exporting BigInteger parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withExporting

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

Adds an exporting BigDecimal parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withExporting

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

Adds an exporting Locale parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withExporting

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

Adds an exporting Year parameter. reflected by a data element

Overrides:

withExporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withExporting

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

Adds an exporting LocalDate parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withExporting

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

Adds an exporting LocalTime parameter reflected by a data element.

Overrides:

withExporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withExportingFields

@Nonnull
public ParameterFields<BapiRequest> 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 AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withExportingFields

@Nonnull
public BapiRequest 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 AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

fields - The exporting fields.

withExportingTable

@Nonnull
public Table<BapiRequest> 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 AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withImporting

@Nonnull
public BapiRequest 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 AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withImporting

@Nonnull
public <T extends ErpType<T>> BapiRequest 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 AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

value - The value of the parameter.

withImporting

@Nonnull
public <T> BapiRequest 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 AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

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 BapiRequest withImporting(String name,
                                          String dataType,
                                          Boolean value)

Adds a importing Boolean parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withImporting

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

Adds a importing Byte parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withImporting

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

Adds a importing Character parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withImporting

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

Adds a importing String parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withImporting

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

Adds a importing Short parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withImporting

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

Adds a importing Integer parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withImporting

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

Adds a importing Long parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withImporting

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

Adds a importing Float parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withImporting

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

Adds a importing Double parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withImporting

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

Adds a importing BigInteger parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withImporting

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

Adds a importing BigDecimal parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withImporting

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

Adds a importing Locale parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withImporting

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

Adds a importing Year parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withImporting

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

Adds a importing LocalDate parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withImporting

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

Adds a importing LocalTime parameter reflected by a data element.

Overrides:

withImporting in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

See Also:

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

withImportingFields

@Nonnull
public ParameterFields<BapiRequest> 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 AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withImportingFields

@Nonnull
public BapiRequest 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 AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

fields - The importing fields.

withImportingTable

@Nonnull
public Table<BapiRequest> 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 AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withImportingAsReturn

@Nonnull
public BapiRequest withImportingAsReturn(String dataType)

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

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

Overrides:

withImportingAsReturn in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Parameters:

dataType - The ABAP data type of the parameter.

withImportingAsReturn

@Nonnull
public BapiRequest 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 AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withTable

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

Adds a table parameter.

Overrides:

withTable in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withTableAsReturn

@Nonnull
public BapiRequest withTableAsReturn(String dataType)

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

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

Overrides:

withTableAsReturn in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Parameters:

dataType - The ABAP data type of the parameter.

withTableAsReturn

@Nonnull
public BapiRequest 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 AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Parameters:

name - The parameter name.

dataType - The ABAP data type of the parameter.

withErrorHandler

@Nonnull
public BapiRequest withErrorHandler(@Nonnull
                                             RemoteFunctionRequestErrorHandler remoteFunctionRequestErrorHandler)

Specifies to invoke the provided RemoteFunctionRequestErrorHandler after the request has been executed.

Overrides:

withErrorHandler in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Parameters:

remoteFunctionRequestErrorHandler - The result handler to invoke after request execution

Returns:

This request to allow for fluent formulation

ignoringErrors

@Nonnull
public BapiRequest ignoringErrors()

Specifies to invoke a RemoteFunctionRequestErrorHandler after the request execution which does not inspect the BapiRequestResult and, therefore, does not throw a RemoteFunctionException.

Overrides:

ignoringErrors in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Returns:

This request to allow for fluent formulation

propagatingErrorsAsExceptions

@Nonnull
public BapiRequest propagatingErrorsAsExceptions()

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

Overrides:

propagatingErrorsAsExceptions in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

Returns:

This request to allow for fluent formulation

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>

toString

public String toString()

Overrides:

toString in class AbstractRemoteFunctionRequest<BapiRequest,BapiRequestResult>