Class BapiRequest
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
ConstructorDescriptionBapiRequest
(String functionName) Deprecated.Constructs a synchronous BAPI request for which the result will be committed.BapiRequest
(String functionName, boolean commit) Deprecated.Constructs a BAPI request.BapiRequest
(String functionName, CommitStrategy commitStrategy) Deprecated.Constructs a BAPI request. -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
Deprecated.boolean
Deprecated.execute
(Destination destination) Deprecated.Executes a given request using the givenDestination
.protected BapiRequest
getThis()
Deprecated.Convenience method that returns the current instance.int
hashCode()
Deprecated.Deprecated.Specifies to invoke aRemoteFunctionRequestErrorHandler
after the request execution which does not inspect theBapiRequestResult
and, therefore, does not throw aRemoteFunctionException
.Deprecated.Specifies to invoke aRemoteFunctionRequestErrorHandler
after the request execution which inspects theBapiRequestResult
and throws aRemoteFunctionException
or one of its more-specific exceptions depending on the returned error messages of the request.toString()
Deprecated.withErrorHandler
(RemoteFunctionRequestErrorHandler remoteFunctionRequestErrorHandler) Deprecated.Specifies to invoke the providedRemoteFunctionRequestErrorHandler
after the request has been executed.withExporting
(String name, String dataType) Deprecated.Adds an exporting parameter reflected by a data element.withExporting
(String name, String dataType, byte[] value) Deprecated.Adds an exporting byte[] parameter reflected by a data element.withExporting
(String name, String dataType, Year value) Deprecated.Adds an exportingYear
parameter. reflected by a data elementwithExporting
(String name, String dataType, Boolean value) Deprecated.Adds an exportingBoolean
parameter reflected by a data element.withExporting
(String name, String dataType, Byte value) Deprecated.Adds an exportingByte
parameter reflected by a data element.withExporting
(String name, String dataType, Character value) Deprecated.Adds an exportingCharacter
parameter reflected by a data element.withExporting
(String name, String dataType, Double value) Deprecated.Adds an exportingDouble
parameter reflected by a data element.withExporting
(String name, String dataType, Float value) Deprecated.Adds an exportingFloat
parameter reflected by a data element.withExporting
(String name, String dataType, Integer value) Deprecated.Adds an exportingInteger
parameter reflected by a data element.withExporting
(String name, String dataType, Long value) Deprecated.Adds an exportingLong
parameter reflected by a data element.withExporting
(String name, String dataType, Short value) Deprecated.Adds an exportingShort
parameter reflected by a data element.withExporting
(String name, String dataType, String value) Deprecated.Adds an exportingString
parameter reflected by a data element.withExporting
(String name, String dataType, BigDecimal value) Deprecated.Adds an exportingBigDecimal
parameter reflected by a data element.withExporting
(String name, String dataType, BigInteger value) Deprecated.Adds an exportingBigInteger
parameter reflected by a data element.withExporting
(String name, String dataType, LocalDate value) Deprecated.Adds an exportingLocalDate
parameter reflected by a data element.withExporting
(String name, String dataType, LocalTime value) Deprecated.Adds an exportingLocalTime
parameter reflected by a data element.withExporting
(String name, String dataType, Locale value) Deprecated.Adds an exportingLocale
parameter reflected by a data element.<T extends ErpType<T>>
BapiRequestwithExporting
(String name, String dataType, T value) Deprecated.Adds an exporting parameter reflected by a data element.<T> BapiRequest
withExporting
(String name, String dataType, T value, ErpTypeConverter<T> typeConverter) Deprecated.Adds an exporting parameter reflected by a data element.withExportingFields
(String name, String dataType) Deprecated.Adds an exporting parameter reflected by a structure.withExportingFields
(String name, String dataType, Fields fields) Deprecated.Adds an exporting parameter reflected by a structure.withExportingTable
(String name, String dataType) Deprecated.Adds an exporting parameter reflected by a table type.withImporting
(String name, String dataType) Deprecated.Adds an importing parameter reflected by a data element.withImporting
(String name, String dataType, Year value) Deprecated.Adds a importingYear
parameter reflected by a data element.withImporting
(String name, String dataType, Boolean value) Deprecated.Adds a importingBoolean
parameter reflected by a data element.withImporting
(String name, String dataType, Byte value) Deprecated.Adds a importingByte
parameter reflected by a data element.withImporting
(String name, String dataType, Character value) Deprecated.Adds a importingCharacter
parameter reflected by a data element.withImporting
(String name, String dataType, Double value) Deprecated.Adds a importingDouble
parameter reflected by a data element.withImporting
(String name, String dataType, Float value) Deprecated.Adds a importingFloat
parameter reflected by a data element.withImporting
(String name, String dataType, Integer value) Deprecated.Adds a importingInteger
parameter reflected by a data element.withImporting
(String name, String dataType, Long value) Deprecated.Adds a importingLong
parameter reflected by a data element.withImporting
(String name, String dataType, Short value) Deprecated.Adds a importingShort
parameter reflected by a data element.withImporting
(String name, String dataType, String value) Deprecated.Adds a importingString
parameter reflected by a data element.withImporting
(String name, String dataType, BigDecimal value) Deprecated.Adds a importingBigDecimal
parameter reflected by a data element.withImporting
(String name, String dataType, BigInteger value) Deprecated.Adds a importingBigInteger
parameter reflected by a data element.withImporting
(String name, String dataType, LocalDate value) Deprecated.Adds a importingLocalDate
parameter reflected by a data element.withImporting
(String name, String dataType, LocalTime value) Deprecated.Adds a importingLocalTime
parameter reflected by a data element.withImporting
(String name, String dataType, Locale value) Deprecated.Adds a importingLocale
parameter reflected by a data element.<T extends ErpType<T>>
BapiRequestwithImporting
(String name, String dataType, T value) Deprecated.Adds an importing parameter reflected by a data element.<T> BapiRequest
withImporting
(String name, String dataType, T value, ErpTypeConverter<T> typeConverter) Deprecated.Adds an importing parameter reflected by a data element.withImportingAsReturn
(String dataType) Deprecated.Adds an importing parameter as a return parameter with the name defined byAbstractRemoteFunctionRequest.RETURN_PARAMETER
.withImportingAsReturn
(String name, String dataType) Deprecated.Adds an importing parameter as a return parameter.withImportingFields
(String name, String dataType) Deprecated.Adds an importing parameter reflected by a structure.withImportingFields
(String name, String dataType, Fields fields) Deprecated.Adds an importing parameter reflected by a structure.withImportingTable
(String name, String dataType) Deprecated.Adds an importing parameter reflected by a table type.Deprecated.Adds a table parameter.withTableAsReturn
(String dataType) Deprecated.Adds a table parameter as a return parameter with the name defined byAbstractRemoteFunctionRequest.RETURN_PARAMETER
.withTableAsReturn
(String name, String dataType) Deprecated.Adds a table parameter as a return parameter.withTypeConverters
(ErpTypeConverter<?>... typeConverters) Deprecated.withTypeConverters
(Iterable<ErpTypeConverter<?>> typeConverters) Deprecated.Registers the givenErpTypeConverter
s.Methods inherited from class com.sap.cloud.sdk.s4hana.connectivity.rfc.AbstractRemoteFunctionRequest
getCommitStrategy, getConstructedByMethod, getFunctionName, getTypeConverters, isPerformingTransactionalCommit
Methods inherited from class com.sap.cloud.sdk.s4hana.connectivity.Request
getCustomHttpHeaders, getLongRunningRequestThreshold, getReadAccessData, getRequestId, setLongRunningRequestThreshold, withHeader, withHeader, withSameCustomHttpHeadersAs
-
Constructor Details
-
BapiRequest
Deprecated.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
Deprecated.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 constructorBapiRequest(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(@Nonnull String functionName, @Nonnull CommitStrategy commitStrategy) throws IllegalArgumentException Deprecated.Constructs a BAPI request.- Parameters:
functionName
- The name of the BAPI to be called.commitStrategy
- Decides on theCommitStrategy
- 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 Details
-
execute
@Nonnull public BapiRequestResult execute(@Nonnull Destination destination) throws RequestSerializationException, RequestExecutionException, DestinationNotFoundException, DestinationAccessException Deprecated.Description copied from class:Request
Executes a given request using the givenDestination
.- Specified by:
execute
in classRequest<BapiRequest,
BapiRequestResult> - Parameters:
destination
- TheDestination
to be used for request execution.- Returns:
- The executed request result.
- 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 theDestination
can be found.DestinationAccessException
- If there is an issue while accessing destination information.
-
getThis
Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Convenience method that returns the current instance.- Specified by:
getThis
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Returns:
- The current instance.
-
withTypeConverters
@Nonnull public BapiRequest withTypeConverters(@Nonnull Iterable<ErpTypeConverter<?>> typeConverters) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Registers the givenErpTypeConverter
s. Replaces existing converters for already existing types that have been added before.- Overrides:
withTypeConverters
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
typeConverters
- The type converters to be added.- Returns:
- The same instance with additional type converters.
-
withTypeConverters
Deprecated.Description copied from class:AbstractRemoteFunctionRequest
- Overrides:
withTypeConverters
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
typeConverters
- The type converters to be added.- Returns:
- The same instance with additional type converters.
-
withExporting
Deprecated.Description copied from class:AbstractRemoteFunctionRequest
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 classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.- Returns:
- This request to allow for fluent formulation
-
withExporting
@Nonnull public <T extends ErpType<T>> BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable T value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
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 classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Type Parameters:
T
- The generic value type.- Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The value of the parameter.- Returns:
- This request to allow for fluent formulation
-
withExporting
@Nonnull public <T> BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable T value, @Nullable ErpTypeConverter<T> typeConverter) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
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 classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Type Parameters:
T
- The generic value type.- 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.- Returns:
- This request to allow for fluent formulation
-
withExporting
@Nonnull public BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable Boolean value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an exportingBoolean
parameter reflected by a data element.- Overrides:
withExporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withExporting
@Nonnull public BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable Byte value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an exportingByte
parameter reflected by a data element.- Overrides:
withExporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withExporting
@Nonnull public BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable Character value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an exportingCharacter
parameter reflected by a data element.- Overrides:
withExporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withExporting
@Nonnull public BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable String value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an exportingString
parameter reflected by a data element.- Overrides:
withExporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withExporting
@Nonnull public BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable Short value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an exportingShort
parameter reflected by a data element.- Overrides:
withExporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withExporting
@Nonnull public BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable Integer value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an exportingInteger
parameter reflected by a data element.- Overrides:
withExporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withExporting
@Nonnull public BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable Long value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an exportingLong
parameter reflected by a data element.- Overrides:
withExporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withExporting
@Nonnull public BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable Float value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an exportingFloat
parameter reflected by a data element.- Overrides:
withExporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withExporting
@Nonnull public BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable Double value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an exportingDouble
parameter reflected by a data element.- Overrides:
withExporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withExporting
@Nonnull public BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable BigInteger value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an exportingBigInteger
parameter reflected by a data element.- Overrides:
withExporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withExporting
@Nonnull public BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable BigDecimal value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an exportingBigDecimal
parameter reflected by a data element.- Overrides:
withExporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withExporting
@Nonnull public BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable Locale value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an exportingLocale
parameter reflected by a data element.- Overrides:
withExporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withExporting
@Nonnull public BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable Year value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an exportingYear
parameter. reflected by a data element- Overrides:
withExporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withExporting
@Nonnull public BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable LocalDate value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an exportingLocalDate
parameter reflected by a data element.- Overrides:
withExporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withExporting
@Nonnull public BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable LocalTime value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an exportingLocalTime
parameter reflected by a data element.- Overrides:
withExporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withExportingFields
@Nonnull public ParameterFields<BapiRequest> withExportingFields(@Nonnull String name, @Nonnull String dataType) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
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 classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.- Returns:
- The ParameterFields to allow for fluent formulation.
-
withExportingFields
@Nonnull public BapiRequest withExportingFields(@Nonnull String name, @Nonnull String dataType, @Nonnull Fields fields) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
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 classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.fields
- The exporting fields.- Returns:
- This request to allow for fluent formulation
-
withExportingTable
@Nonnull public Table<BapiRequest> withExportingTable(@Nonnull String name, @Nonnull String dataType) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
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 classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.- Returns:
- The Table to allow for fluent formulation.
-
withImporting
Deprecated.Description copied from class:AbstractRemoteFunctionRequest
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 classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.- Returns:
- This request to allow for fluent formulation
-
withImporting
@Nonnull public <T extends ErpType<T>> BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable T value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
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 classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Type Parameters:
T
- The generic value type.- Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The value of the parameter.- Returns:
- This request to allow for fluent formulation
-
withImporting
@Nonnull public <T> BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable T value, @Nullable ErpTypeConverter<T> typeConverter) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
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 classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Type Parameters:
T
- The generic value type.- 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.- Returns:
- This request to allow for fluent formulation
-
withImporting
@Nonnull public BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable Boolean value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a importingBoolean
parameter reflected by a data element.- Overrides:
withImporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withImporting
@Nonnull public BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable Byte value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a importingByte
parameter reflected by a data element.- Overrides:
withImporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withExporting
@Nonnull public BapiRequest withExporting(@Nonnull String name, @Nonnull String dataType, @Nullable byte[] value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an exporting byte[] parameter reflected by a data element.- Overrides:
withExporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request, to allow for fluent formulation
- See Also:
-
withImporting
@Nonnull public BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable Character value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a importingCharacter
parameter reflected by a data element.- Overrides:
withImporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withImporting
@Nonnull public BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable String value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a importingString
parameter reflected by a data element.- Overrides:
withImporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withImporting
@Nonnull public BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable Short value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a importingShort
parameter reflected by a data element.- Overrides:
withImporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withImporting
@Nonnull public BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable Integer value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a importingInteger
parameter reflected by a data element.- Overrides:
withImporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withImporting
@Nonnull public BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable Long value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a importingLong
parameter reflected by a data element.- Overrides:
withImporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withImporting
@Nonnull public BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable Float value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a importingFloat
parameter reflected by a data element.- Overrides:
withImporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withImporting
@Nonnull public BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable Double value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a importingDouble
parameter reflected by a data element.- Overrides:
withImporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withImporting
@Nonnull public BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable BigInteger value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a importingBigInteger
parameter reflected by a data element.- Overrides:
withImporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withImporting
@Nonnull public BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable BigDecimal value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a importingBigDecimal
parameter reflected by a data element.- Overrides:
withImporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withImporting
@Nonnull public BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable Locale value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a importingLocale
parameter reflected by a data element.- Overrides:
withImporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withImporting
@Nonnull public BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable Year value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a importingYear
parameter reflected by a data element.- Overrides:
withImporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withImporting
@Nonnull public BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable LocalDate value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a importingLocalDate
parameter reflected by a data element.- Overrides:
withImporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withImporting
@Nonnull public BapiRequest withImporting(@Nonnull String name, @Nonnull String dataType, @Nullable LocalTime value) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a importingLocalTime
parameter reflected by a data element.- Overrides:
withImporting
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The optional parameter value.- Returns:
- This request to allow for fluent formulation
- See Also:
-
withImportingFields
@Nonnull public ParameterFields<BapiRequest> withImportingFields(@Nonnull String name, @Nonnull String dataType) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
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 classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.- Returns:
- The ParameterFields to allow for fluent formulation.
-
withImportingFields
@Nonnull public BapiRequest withImportingFields(@Nonnull String name, @Nonnull String dataType, @Nonnull Fields fields) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
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 classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.fields
- The importing fields.- Returns:
- This request to allow for fluent formulation
-
withImportingTable
@Nonnull public Table<BapiRequest> withImportingTable(@Nonnull String name, @Nonnull String dataType) Deprecated.Description copied from class:AbstractRemoteFunctionRequest
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 classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.- Returns:
- The table to allow for fluent formulation.
-
withImportingAsReturn
Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds an importing parameter as a return parameter with the name defined byAbstractRemoteFunctionRequest.RETURN_PARAMETER
.Note that return parameters refer to parameters for which return messages will be parsed and translated to RemoteFunctionMessages.
- Overrides:
withImportingAsReturn
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
dataType
- The ABAP data type of the parameter.- Returns:
- This request to allow for fluent formulation
-
withImportingAsReturn
Deprecated.Description copied from class:AbstractRemoteFunctionRequest
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 classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.- Returns:
- This request to allow for fluent formulation
-
withTable
Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a table parameter.- Overrides:
withTable
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.- Returns:
- The Table to allow for fluent formulation.
-
withTableAsReturn
Deprecated.Description copied from class:AbstractRemoteFunctionRequest
Adds a table parameter as a return parameter with the name defined byAbstractRemoteFunctionRequest.RETURN_PARAMETER
.Note that return parameters refer to parameters for which return messages will be parsed and translated to RemoteFunctionMessages.
- Overrides:
withTableAsReturn
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
dataType
- The ABAP data type of the parameter.- Returns:
- This request to allow for fluent formulation
-
withTableAsReturn
Deprecated.Description copied from class:AbstractRemoteFunctionRequest
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 classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
name
- The parameter name.dataType
- The ABAP data type of the parameter.- Returns:
- This request to allow for fluent formulation
-
withErrorHandler
@Nonnull public BapiRequest withErrorHandler(@Nonnull RemoteFunctionRequestErrorHandler remoteFunctionRequestErrorHandler) Deprecated.Specifies to invoke the providedRemoteFunctionRequestErrorHandler
after the request has been executed.- Overrides:
withErrorHandler
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Parameters:
remoteFunctionRequestErrorHandler
- The result handler to invoke after request execution- Returns:
- This request to allow for fluent formulation
-
ignoringErrors
Deprecated.Specifies to invoke aRemoteFunctionRequestErrorHandler
after the request execution which does not inspect theBapiRequestResult
and, therefore, does not throw aRemoteFunctionException
.- Overrides:
ignoringErrors
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Returns:
- This request to allow for fluent formulation
-
propagatingErrorsAsExceptions
Deprecated.Specifies to invoke aRemoteFunctionRequestErrorHandler
after the request execution which inspects theBapiRequestResult
and throws aRemoteFunctionException
or one of its more-specific exceptions depending on the returned error messages of the request.- Overrides:
propagatingErrorsAsExceptions
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult> - Returns:
- This request to allow for fluent formulation
-
equals
Deprecated.- Overrides:
equals
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult>
-
canEqual
Deprecated.- Overrides:
canEqual
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult>
-
hashCode
public int hashCode()Deprecated.- Overrides:
hashCode
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult>
-
toString
Deprecated.- Overrides:
toString
in classAbstractRemoteFunctionRequest<BapiRequest,
BapiRequestResult>
-