ResultElement (SAP Cloud SDK - Parent POM 2.19.1 API)

All Known Subinterfaces:

ResultCollection, ResultObject, ResultPrimitive

All Known Implementing Classes:

DefaultResultCollection, GsonResultObject, GsonResultPrimitive
```
public interface ResultElement
```
Class representing one resulting element from a call to an external service (e.g. after invoking a BAPI or a remote-enabled function module).
Note that accessing the result element varies depending on its structure:
- If the result element represents an unstructured value (e.g. a String object), it is considered a ResultPrimitive.
  When dealing with BAPI or RFM query results, this occurs if the respective result element is reflected as a data element in the ABAP Data Dictionary.
- If the result element represents a structured object (e.g. one complex business object), it is considered a ResultObject.
  When dealing with BAPI or RFM query results, this occurs if the respective result element is reflected as a structure in the ABAP Data Dictionary.
- If the result element represents a collection of result elements (e.g. a list of complex business objects), it is considered a ResultCollection.
  When dealing with BAPI or RFM query results, this occurs if the respective result element is reflected as a table type in the ABAP Data Dictionary or is used as tables parameter in the interface of the BAPI or RFM.
Use the methods isResultPrimitive(), isResultObject(), or isResultCollection() to check for the respective case.
As accessing the content of the result element varies depending on its structure, use the methods getAsPrimitive(), getAsObject(), or getAsCollection() to access the result element content.
If the result element is considered a ResultPrimitive, its content can be accessed with the respective method directly, such as asString() to obtain the result element content as String object.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BigDecimal`	`asBigDecimal()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `BigDecimal`.
`BigInteger`	`asBigInteger()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `BigInteger`.
`boolean`	`asBoolean()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `boolean`.
`byte`	`asByte()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `byte`.
`char`	`asCharacter()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `char`.
`double`	`asDouble()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `double`.
`float`	`asFloat()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `float`.
`int`	`asInteger()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `int`.
`long`	`asLong()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `long`.
`short`	`asShort()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `short`.
`String`	`asString()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `String`.
`ResultCollection`	`getAsCollection()` Returns this `ResultElement` as an instance of `ResultCollection`.
`ResultObject`	`getAsObject()` Returns this `ResultElement` as an instance of `ResultObject`.
`ResultPrimitive`	`getAsPrimitive()` Returns this `ResultElement` as an instance of `ResultPrimitive`.
`boolean`	`isResultCollection()` Checks whether this `ResultElement` represents a collection of result elements and, therefore, is a `ResultCollection`.
`boolean`	`isResultObject()` Checks whether this `ResultElement` represents a structured object and, therefore, is a `ResultObject`.
`boolean`	`isResultPrimitive()` Checks whether this `ResultElement` represents an unstructured value and, therefore, is a `ResultPrimitive`.

- Method Detail
  - isResultPrimitive
```
boolean isResultPrimitive()
```
    Checks whether this ResultElement represents an unstructured value and, therefore, is a ResultPrimitive.
    
    Returns:
    
    True of this object is a ResultPrimitive, otherwise false.
  - isResultCollection
```
boolean isResultCollection()
```
    Checks whether this ResultElement represents a collection of result elements and, therefore, is a ResultCollection.
    
    Returns:
    
    True of this object is a ResultCollection, otherwise false.
  - isResultObject
```
boolean isResultObject()
```
    Checks whether this ResultElement represents a structured object and, therefore, is a ResultObject.
    
    Returns:
    
    True of this object is a ResultObject, otherwise false.
  - getAsPrimitive
```
@Nonnull
ResultPrimitive getAsPrimitive()
                                 throws UnsupportedOperationException
```
    Returns this ResultElement as an instance of ResultPrimitive.
    
    Returns:
    
    An instance of ResultPrimitive.
    
    Throws:
    
    UnsupportedOperationException - If the cast into ResultPrimitive failed, e.g. in case it is not a primitive.
  - getAsCollection
```
@Nonnull
ResultCollection getAsCollection()
                                   throws UnsupportedOperationException
```
    Returns this ResultElement as an instance of ResultCollection.
    
    Returns:
    
    An instance of ResultCollection.
    
    Throws:
    
    UnsupportedOperationException - If the cast into ResultCollection failed, e.g. in case it is not a collection.
  - getAsObject
```
@Nonnull
ResultObject getAsObject()
                           throws UnsupportedOperationException
```
    Returns this ResultElement as an instance of ResultObject.
    
    Returns:
    
    An instance of ResultObject.
    
    Throws:
    
    UnsupportedOperationException - If the cast into ResultObject failed, e.g. in case it is not an object.
  - asBoolean
```
boolean asBoolean()
           throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as boolean.
    
    Returns:
    
    boolean value.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as boolean.
  - asByte
```
byte asByte()
     throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as byte.
    
    Returns:
    
    byte value.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as byte.
  - asCharacter
```
char asCharacter()
          throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as char.
    
    Returns:
    
    char value.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as char.
  - asString
```
@Nonnull
String asString()
                  throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as String.
    
    Returns:
    
    String object.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as String.
  - asInteger
```
int asInteger()
       throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as int.
    
    Returns:
    
    int value.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as int.
  - asShort
```
short asShort()
       throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as short.
    
    Returns:
    
    short value.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as short.
  - asLong
```
long asLong()
     throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as long.
    
    Returns:
    
    long value.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as long.
  - asFloat
```
float asFloat()
       throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as float.
    
    Returns:
    
    float value.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as float.
  - asDouble
```
double asDouble()
         throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as double.
    
    Returns:
    
    double value.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as double.
  - asBigInteger
```
@Nonnull
BigInteger asBigInteger()
                          throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as BigInteger.
    
    Returns:
    
    BigInteger object.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as BigInteger.
  - asBigDecimal
```
@Nonnull
BigDecimal asBigDecimal()
                          throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as BigDecimal.
    
    Returns:
    
    BigDecimal object.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as BigDecimal.

Interface ResultElement

Method Summary

Method Detail

isResultPrimitive

isResultCollection

isResultObject

getAsPrimitive

getAsCollection

getAsObject

asBoolean

asByte

asCharacter

asString

asInteger

asShort

asLong

asFloat

asDouble

asBigInteger

asBigDecimal