com.sap.cloud.sdk.result

Interface ResultObject

All Superinterfaces:

ResultElement

All Known Implementing Classes:

GsonResultObject

public interface ResultObject
extends ResultElement

Interface representing one structured object (e.g one complex business object) resulting from a call to an external service (e.g. after invoking a BAPI or a remote-enabled function module).

Use the method get(String) to access one particular element inside this object as ResultElement.

Use the method as(Class) to cast this object into a given class type.

Method Summary

Modifier and Type	Method and Description
<T> T	as(Class<T> objectType) Returns this ResultObject casted into the given type T.
<T> T	as(Type objectType) Returns this ResultObject casted into the given type T.
ResultElement	get(String elementName) Returns one particular element inside this result object identified by its name.

Methods inherited from interface com.sap.cloud.sdk.result.ResultElement

asBigDecimal, asBigInteger, asBoolean, asByte, asCharacter, asDouble, asFloat, asInteger, asLong, asShort, asString, getAsCollection, getAsObject, getAsPrimitive, isResultCollection, isResultObject, isResultPrimitive

Method Detail

get

@Nullable
ResultElement get(@Nonnull
                            String elementName)
                     throws UnsupportedOperationException

Returns one particular element inside this result object identified by its name.

Parameters:

elementName - Name of the requested element.

Returns:

The found element as ResultElement.

Throws:

UnsupportedOperationException - If requested element cannot be found within this object.

as

@Nonnull
<T> T as(@Nonnull
                  Class<T> objectType)
           throws UnsupportedOperationException

Returns this ResultObject casted into the given type T.

Type Parameters:

T - The type the result object shall be casted to.

Parameters:

objectType - The Class type of the type T

Returns:

An instance of T.

Throws:

UnsupportedOperationException - If the cast into the given object type failed.

as

@Nonnull
<T> T as(@Nonnull
                  Type objectType)
           throws UnsupportedOperationException

Returns this ResultObject casted into the given type T.

Type Parameters:

T - The type the result object shall be casted to.

Parameters:

objectType - The Type of the type T

Returns:

An instance of T.

Throws:

UnsupportedOperationException - If the cast into the given object type failed.