public class BapiQuery extends Query<QueryT,QueryResultT>
Constructor and Description |
---|
BapiQuery(String functionName)
Constructs a BAPI query for which the result will be committed.
|
BapiQuery(String functionName,
boolean commit)
Constructs a BAPI query.
|
Modifier and Type | Method and Description |
---|---|
boolean |
doCommit() |
boolean |
equals(Object o) |
BapiQueryResult |
execute(ErpEndpoint erpEndpoint) |
String |
getConstructedByMethod() |
String |
getFunctionName() |
Collection<ErpTypeConverter<?>> |
getTypeConverters() |
int |
hashCode() |
String |
toString() |
BapiQuery |
withExporting(String name,
String dataType)
Adds an exporting parameter.
|
BapiQuery |
withExporting(String name,
String dataType,
BigDecimal value)
Adds an exporting
BigDecimal parameter. |
BapiQuery |
withExporting(String name,
String dataType,
BigInteger value)
Adds an exporting
BigInteger parameter. |
BapiQuery |
withExporting(String name,
String dataType,
Boolean value)
Adds an exporting
Boolean parameter. |
BapiQuery |
withExporting(String name,
String dataType,
Byte value)
Adds an exporting
Byte parameter. |
BapiQuery |
withExporting(String name,
String dataType,
Character value)
Adds an exporting
Character parameter. |
BapiQuery |
withExporting(String name,
String dataType,
Double value)
Adds an exporting
Double parameter. |
BapiQuery |
withExporting(String name,
String dataType,
Float value)
Adds an exporting
Float parameter. |
BapiQuery |
withExporting(String name,
String dataType,
Integer value)
Adds an exporting
Integer parameter. |
BapiQuery |
withExporting(String name,
String dataType,
org.joda.time.LocalDate value)
Adds an exporting
LocalDate parameter. |
BapiQuery |
withExporting(String name,
String dataType,
Locale value)
Adds an exporting
Locale parameter. |
BapiQuery |
withExporting(String name,
String dataType,
org.joda.time.LocalTime value)
Adds an exporting
LocalTime parameter. |
BapiQuery |
withExporting(String name,
String dataType,
Long value)
Adds an exporting
Long parameter. |
BapiQuery |
withExporting(String name,
String dataType,
Short value)
Adds an exporting
Short parameter. |
BapiQuery |
withExporting(String name,
String dataType,
String value)
Adds an exporting
String parameter. |
<T extends ErpType<T>> |
withExporting(String name,
String dataType,
T value)
Adds an exporting parameter.
|
<T> BapiQuery |
withExporting(String name,
String dataType,
T value,
ErpTypeConverter<T> typeConverter)
Adds an exporting parameter.
|
BapiQuery |
withExporting(String name,
String dataType,
Year value)
Adds an exporting
Year parameter. |
ParameterFields<BapiQuery> |
withExportingFields(String name,
String dataType)
Adds an exporting fields parameter for multiple values.
|
BapiQuery |
withExportingFields(String name,
String dataType,
Fields fields)
Adds an exporting fields parameter for multiple values.
|
Table<BapiQuery> |
withExportingTable(String name,
String dataType)
Adds an exporting table parameter.
|
BapiQuery |
withImporting(String name,
String dataType)
Adds an importing parameter.
|
BapiQuery |
withImporting(String name,
String dataType,
BigDecimal value)
Adds a importing
BigDecimal parameter. |
BapiQuery |
withImporting(String name,
String dataType,
BigInteger value)
Adds a importing
BigInteger parameter. |
BapiQuery |
withImporting(String name,
String dataType,
Boolean value)
Adds a importing
Boolean parameter. |
BapiQuery |
withImporting(String name,
String dataType,
Byte value)
Adds a importing
Byte parameter. |
BapiQuery |
withImporting(String name,
String dataType,
Character value)
Adds a importing
Character parameter. |
BapiQuery |
withImporting(String name,
String dataType,
Double value)
Adds a importing
Double parameter. |
BapiQuery |
withImporting(String name,
String dataType,
Float value)
Adds a importing
Float parameter. |
BapiQuery |
withImporting(String name,
String dataType,
Integer value)
Adds a importing
Integer parameter. |
BapiQuery |
withImporting(String name,
String dataType,
org.joda.time.LocalDate value)
Adds a importing
LocalDate parameter. |
BapiQuery |
withImporting(String name,
String dataType,
Locale value)
Adds a importing
Locale parameter. |
BapiQuery |
withImporting(String name,
String dataType,
org.joda.time.LocalTime value)
Adds a importing
LocalTime parameter. |
BapiQuery |
withImporting(String name,
String dataType,
Long value)
Adds a importing
Long parameter. |
BapiQuery |
withImporting(String name,
String dataType,
Short value)
Adds a importing
Short parameter. |
BapiQuery |
withImporting(String name,
String dataType,
String value)
Adds a importing
String parameter. |
<T extends ErpType<T>> |
withImporting(String name,
String dataType,
T value)
Adds an importing parameter.
|
<T> BapiQuery |
withImporting(String name,
String dataType,
T value,
ErpTypeConverter<T> typeConverter)
Adds an importing parameter.
|
BapiQuery |
withImporting(String name,
String dataType,
Year value)
Adds a importing
Year parameter. |
BapiQuery |
withImportingAsReturn(String dataType)
Adds an importing parameter as a return parameter with the name defined by
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 fields parameter for multiple values.
|
BapiQuery |
withImportingFields(String name,
String dataType,
Fields fields)
Adds an importing fields parameter for multiple values.
|
Table<BapiQuery> |
withImportingTable(String name,
String dataType)
Adds an importing table parameter.
|
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
RETURN_PARAMETER . |
BapiQuery |
withTableAsReturn(String name,
String dataType)
Adds a table parameter as a return parameter.
|
BapiQuery |
withTypeConverters(ErpTypeConverter<?>... typeConverters)
Delegates to
withTypeConverters(Iterable) . |
BapiQuery |
withTypeConverters(Iterable<ErpTypeConverter<?>> typeConverters)
Registers the given
ErpTypeConverter s. |
getReadAccessData, getRequestId
public static final String TYPE_ID
public BapiQuery(String functionName) throws IllegalArgumentException
functionName
- The name of the BAPI to be called.IllegalArgumentException
- If the given function is not a valid BAPI, i.e., its name does not start with the prefix "BAPI".public BapiQuery(String functionName, boolean commit) throws IllegalArgumentException
functionName
- The name of the BAPI to be called.commit
- Decides whether to commit the result of the BAPI call.IllegalArgumentException
- If the given function is not a valid BAPI, i.e., its name does not start with the prefix "BAPI".public BapiQueryResult execute(ErpEndpoint erpEndpoint) throws QuerySerializationException, QueryExecutionException
execute
in class Query<BapiQuery,BapiQueryResult>
QuerySerializationException
QueryExecutionException
public BapiQuery withTypeConverters(Iterable<ErpTypeConverter<?>> typeConverters)
ErpTypeConverter
s. Replaces existing converters for already existing types that have
been added before.public BapiQuery withTypeConverters(ErpTypeConverter<?>... typeConverters)
withTypeConverters(Iterable)
.public BapiQuery withExporting(String name, String dataType)
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.
name
- The parameter name.dataType
- The ABAP data type of the parameter.public <T extends ErpType<T>> BapiQuery withExporting(String name, String dataType, T value)
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.
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The value of the parameter.public <T> BapiQuery withExporting(String name, String dataType, T value, ErpTypeConverter<T> typeConverter)
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.
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.public BapiQuery withExporting(String name, String dataType, Boolean value)
Boolean
parameter.public BapiQuery withExporting(String name, String dataType, Byte value)
Byte
parameter.public BapiQuery withExporting(String name, String dataType, Character value)
Character
parameter.public BapiQuery withExporting(String name, String dataType, String value)
String
parameter.public BapiQuery withExporting(String name, String dataType, Short value)
Short
parameter.public BapiQuery withExporting(String name, String dataType, Integer value)
Integer
parameter.public BapiQuery withExporting(String name, String dataType, Long value)
Long
parameter.public BapiQuery withExporting(String name, String dataType, Float value)
Float
parameter.public BapiQuery withExporting(String name, String dataType, Double value)
Double
parameter.public BapiQuery withExporting(String name, String dataType, BigInteger value)
BigInteger
parameter.public BapiQuery withExporting(String name, String dataType, BigDecimal value)
BigDecimal
parameter.public BapiQuery withExporting(String name, String dataType, Locale value)
Locale
parameter.public BapiQuery withExporting(String name, String dataType, Year value)
Year
parameter.public BapiQuery withExporting(String name, String dataType, org.joda.time.LocalDate value)
LocalDate
parameter.public BapiQuery withExporting(String name, String dataType, org.joda.time.LocalTime value)
LocalTime
parameter.public ParameterFields<BapiQuery> withExportingFields(String name, String dataType)
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.
name
- The parameter name.dataType
- The ABAP data type of the parameter.public BapiQuery withExportingFields(String name, String dataType, Fields fields)
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.
name
- The parameter name.dataType
- The ABAP data type of the parameter.fields
- The exporting fields.public Table<BapiQuery> withExportingTable(String name, String dataType)
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.
name
- The parameter name.dataType
- The ABAP data type of the parameter.public BapiQuery withImporting(String name, String dataType)
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.
name
- The parameter name.dataType
- The ABAP data type of the parameter.public <T extends ErpType<T>> BapiQuery withImporting(String name, String dataType, T value)
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.
name
- The parameter name.dataType
- The ABAP data type of the parameter.value
- The value of the parameter.public <T> BapiQuery withImporting(String name, String dataType, T value, ErpTypeConverter<T> typeConverter)
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.
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.public BapiQuery withImporting(String name, String dataType, Boolean value)
Boolean
parameter.public BapiQuery withImporting(String name, String dataType, Byte value)
Byte
parameter.public BapiQuery withImporting(String name, String dataType, Character value)
Character
parameter.public BapiQuery withImporting(String name, String dataType, String value)
String
parameter.public BapiQuery withImporting(String name, String dataType, Short value)
Short
parameter.public BapiQuery withImporting(String name, String dataType, Integer value)
Integer
parameter.public BapiQuery withImporting(String name, String dataType, Long value)
Long
parameter.public BapiQuery withImporting(String name, String dataType, Float value)
Float
parameter.public BapiQuery withImporting(String name, String dataType, Double value)
Double
parameter.public BapiQuery withImporting(String name, String dataType, BigInteger value)
BigInteger
parameter.public BapiQuery withImporting(String name, String dataType, BigDecimal value)
BigDecimal
parameter.public BapiQuery withImporting(String name, String dataType, Locale value)
Locale
parameter.public BapiQuery withImporting(String name, String dataType, Year value)
Year
parameter.public BapiQuery withImporting(String name, String dataType, org.joda.time.LocalDate value)
LocalDate
parameter.public BapiQuery withImporting(String name, String dataType, org.joda.time.LocalTime value)
LocalTime
parameter.public ParameterFields<BapiQuery> withImportingFields(String name, String dataType)
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.
name
- The parameter name.dataType
- The ABAP data type of the parameter.public BapiQuery withImportingFields(String name, String dataType, Fields fields)
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.
name
- The parameter name.dataType
- The ABAP data type of the parameter.fields
- The importing fields.public Table<BapiQuery> withImportingTable(String name, String dataType)
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.
name
- The parameter name.dataType
- The ABAP data type of the parameter.public BapiQuery withImportingAsReturn(String dataType)
RETURN_PARAMETER
.
Note that return parameters refer to parameters for which return messages will be parsed and translated to
RemoteFunctionMessage
s.
dataType
- The ABAP data type of the parameter.public BapiQuery withImportingAsReturn(String name, String dataType)
Note that return parameters refer to parameters for which return messages will be parsed and translated to
RemoteFunctionMessage
s.
name
- The parameter name.dataType
- The ABAP data type of the parameter.public Table<BapiQuery> withTable(String name, String dataType)
name
- The parameter name.dataType
- The ABAP data type of the parameter.public BapiQuery withTableAsReturn(String dataType)
RETURN_PARAMETER
.
Note that return parameters refer to parameters for which return messages will be parsed and translated to
RemoteFunctionMessage
s.
dataType
- The ABAP data type of the parameter.public BapiQuery withTableAsReturn(String name, String dataType)
Note that return parameters refer to parameters for which return messages will be parsed and translated to
RemoteFunctionMessage
s.
name
- The parameter name.dataType
- The ABAP data type of the parameter.@Generated(value="lombok") public boolean equals(Object o)
@Generated(value="lombok") public int hashCode()
@Generated(value="lombok") public String toString()
public Collection<ErpTypeConverter<?>> getTypeConverters()
public String getFunctionName()
public boolean doCommit()
true
if the result of the function call will be committed, false
otherwise.@Generated(value="lombok") public String getConstructedByMethod()
getConstructedByMethod
in class Query<QueryT extends com.sap.cloud.sdk.s4hana.connectivity.rfc.AbstractRemoteFunctionQuery<QueryT,QueryResultT>,QueryResultT extends com.sap.cloud.sdk.s4hana.connectivity.rfc.AbstractRemoteFunctionQueryResult<QueryT,QueryResultT>>
Copyright © 2017 SAP SE. All rights reserved.