com.sap.cloud.sdk.result

Interface ResultCollection

All Superinterfaces:

Iterable<ResultElement>, ResultElement

All Known Implementing Classes:

DefaultResultCollection

public interface ResultCollection
extends ResultElement, Iterable<ResultElement>

Interface representing one collection of result elements (e.g. a list of complex business objects) resulting from a call to an external service (e.g. after invoking a BAPI or a remote-enabled function module).

Use the method collect(String) to collect elements inside this object as CollectedResultCollection identified by a certain name.

Use the method asList(Class) to cast this collection into a list of instances of a certain class type.

Use the method asSet(Class) to cast this collection into a set of instances of a certain class type.

To cast this collection into a set or list of built-in data and object types, use methods such as asStringList() or asStringSet().

Method Summary

Modifier and Type	Method and Description
List<BigDecimal>	asBigDecimalList() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as BigDecimal.
Set<BigDecimal>	asBigDecimalSet() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as BigDecimal.
List<BigInteger>	asBigIntegerList() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as BigInteger.
Set<BigInteger>	asBigIntegerSet() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as BigInteger.
List<Boolean>	asBooleanList() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as Boolean.
Set<Boolean>	asBooleanSet() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as Boolean.
List<Byte>	asByteList() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as Byte.
Set<Byte>	asByteSet() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as Byte.
List<Character>	asCharacterList() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as Character.
Set<Character>	asCharacterSet() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as Character.
List<Double>	asDoubleList() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as Double.
Set<Double>	asDoubleSet() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as Double.
List<Float>	asFloatList() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as Float.
Set<Float>	asFloatSet() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as Float.
List<Integer>	asIntegerList() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as Integer.
Set<Integer>	asIntegerSet() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as Integer.
<T> List<T>	asList(Class<T> objectType) Casts all elements within this ResultCollection into type T and returns a List of them.
List<Long>	asLongList() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as Long.
Set<Long>	asLongSet() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as Long.
<T> Set<T>	asSet(Class<T> objectType) Casts all elements within this ResultCollection into type T and returns a Set of them.
List<Short>	asShortList() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as Short.
Set<Short>	asShortSet() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as Short.
List<String>	asStringList() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as String.
Set<String>	asStringSet() Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as String.
CollectedResultCollection	collect(String filterName) Collects elements inside this ResultCollection identified by filterName and returns a CollectedResultCollection that contains only the collected elements.

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

collect

@Nonnull
CollectedResultCollection collect(@Nonnull
                                           String filterName)

Collects elements inside this ResultCollection identified by filterName and returns a CollectedResultCollection that contains only the collected elements.

Parameters:

filterName - The name used to identify the items to collect.

Returns:

Instance of CollectedResultCollection that contains only the collected elements.

asList

@Nonnull
<T> List<T> asList(@Nonnull
                            Class<T> objectType)
                     throws UnsupportedOperationException

Casts all elements within this ResultCollection into type T and returns a List of them.

Type Parameters:

T - The type the elements in this collection object shall be casted to.

Parameters:

objectType - The Class type of the type T.

Returns:

A List of all elements within this ResultCollection casted into class type T.

Throws:

UnsupportedOperationException - If this class does not support the creation of a List or at least one element could not be cast to T.

asSet

@Nonnull
<T> Set<T> asSet(@Nonnull
                          Class<T> objectType)
                   throws UnsupportedOperationException

Casts all elements within this ResultCollection into type T and returns a Set of them.

Type Parameters:

T - The type the elements in this collection object shall be casted to.

Parameters:

objectType - The Class type of the type T.

Returns:

A Set of all elements within this ResultCollection casted into class type T.

Throws:

UnsupportedOperationException - If this class does not support the creation of a Set or at least one element could not be cast to T.

asBooleanList

@Nonnull
List<Boolean> asBooleanList()
                              throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as Boolean.

Returns:

List of Boolean objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a List or at least one element could not be cast to Boolean.

asBooleanSet

@Nonnull
Set<Boolean> asBooleanSet()
                            throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as Boolean.

Returns:

Set of Boolean objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a Set or at least one element could not be cast to Boolean.

asByteList

@Nonnull
List<Byte> asByteList()
                        throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as Byte.

Returns:

List of Byte objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a List or at least one element could not be cast to Byte.

asByteSet

@Nonnull
Set<Byte> asByteSet()
                      throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as Byte.

Returns:

Set of Byte objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a Set or at least one element could not be cast to Byte.

asCharacterList

@Nonnull
List<Character> asCharacterList()
                                  throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as Character.

Returns:

List of Character objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a List or at least one element could not be cast to Character.

asCharacterSet

@Nonnull
Set<Character> asCharacterSet()
                                throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as Character.

Returns:

Set of Character objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a Set or at least one element could not be cast to Character.

asStringList

@Nonnull
List<String> asStringList()
                            throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as String.

Returns:

List of String objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a List or at least one element could not be cast to String.

asStringSet

@Nonnull
Set<String> asStringSet()
                          throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as String.

Returns:

Set of String objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a Set or at least one element could not be cast to String.

asIntegerList

@Nonnull
List<Integer> asIntegerList()
                              throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as Integer.

Returns:

List of Integer objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a List or at least one element could not be cast to Integer.

asIntegerSet

@Nonnull
Set<Integer> asIntegerSet()
                            throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as Integer.

Returns:

Set of Integer objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a Set or at least one element could not be cast to Integer.

asShortList

@Nonnull
List<Short> asShortList()
                          throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as Short.

Returns:

List of Short objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a List or at least one element could not be cast to Short.

asShortSet

@Nonnull
Set<Short> asShortSet()
                        throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as Short.

Returns:

Set of Short objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a Set or at least one element could not be cast to Short.

asLongList

@Nonnull
List<Long> asLongList()
                        throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as Long.

Returns:

List of Long objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a List or at least one element could not be cast to Long.

asLongSet

@Nonnull
Set<Long> asLongSet()
                      throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as Long.

Returns:

Set of Long objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a Set or at least one element could not be cast to Long.

asFloatList

@Nonnull
List<Float> asFloatList()
                          throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as Float.

Returns:

List of Float objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a List or at least one element could not be cast to Float.

asFloatSet

@Nonnull
Set<Float> asFloatSet()
                        throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as Float.

Returns:

Set of Float objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a Set or at least one element could not be cast to Float.

asDoubleList

@Nonnull
List<Double> asDoubleList()
                            throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as Double.

Returns:

List of Double objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a List or at least one element could not be cast to Double.

asDoubleSet

@Nonnull
Set<Double> asDoubleSet()
                          throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as Double.

Returns:

Set of Double objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a Set or at least one element could not be cast to Double.

asBigIntegerList

@Nonnull
List<BigInteger> asBigIntegerList()
                                    throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as BigInteger.

Returns:

List of BigInteger objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a List or at least one element could not be cast to BigInteger.

asBigIntegerSet

@Nonnull
Set<BigInteger> asBigIntegerSet()
                                  throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as BigInteger.

Returns:

Set of BigInteger objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a Set or at least one element could not be cast to BigInteger.

asBigDecimalList

@Nonnull
List<BigDecimal> asBigDecimalList()
                                    throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a List of all their values represented as BigDecimal.

Returns:

List of BigDecimal objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a List or at least one element could not be cast to BigDecimal.

asBigDecimalSet

@Nonnull
Set<BigDecimal> asBigDecimalSet()
                                  throws UnsupportedOperationException

Assuming all elements within this ResultCollection are instances of ResultPrimitive, this method returns a Set of all their values represented as BigDecimal.

Returns:

Set of BigDecimal objects.

Throws:

UnsupportedOperationException - If this class does not support the creation of a Set or at least one element could not be cast to BigDecimal.