com.sap.cloud.sdk.s4hana.connectivity.rfc

Class BapiQueryResult

java.lang.Object

com.sap.cloud.sdk.s4hana.connectivity.rfc.BapiQueryResult

All Implemented Interfaces:

QueryResult<BapiQuery,BapiQueryResult>, Iterable<ResultElement>

public class BapiQueryResult
extends Object

Class representing the result of a BAPI call returned by BapiQuery.

Use the methods get(String), get(int), getIfPresent(String), collect(String), size(), isEmpty(), or has(String) to access the content of the BapiQueryResult.

Use the methods hasFailed(), hasSuccessMessages(), hasInformationMessages(), hasWarningMessages(), or hasErrorMessages() to inspect the resulting messages from the BAPI call.

Constructor Summary

Constructors

Constructor and Description
BapiQueryResult()

Method Summary

Modifier and Type	Method and Description
CollectedResultCollection	collect(String elementName) Collects the resulting elements with the given name from the parameters of this result.
ResultElement	get(int index) Returns the element with the given name from this result.
ResultElement	get(String elementName) Returns the element with the given name from this result.
List<RemoteFunctionMessage>	getErrorMessages()
com.google.common.base.Optional<ResultElement>	getIfPresent(String elementName) Returns the element with the given name from this result.
List<RemoteFunctionMessage>	getInformationMessages()
QueryT	getQuery() ERP query from which this result originates.
ArrayList<ResultElement>	getResultElements()
List<RemoteFunctionMessage>	getSuccessMessages()
List<RemoteFunctionMessage>	getWarningMessages()
boolean	has(String elementName) Indicates whether the element with the given name exists in the result.
boolean	hasErrorMessages()
boolean	hasFailed()
boolean	hasInformationMessages() Indicates whether information messages occurred during BAPI execution.
boolean	hasSuccessMessages() Indicates whether success messages occurred during BAPI execution.
boolean	hasWarningMessages() Indicates whether warning messages occurred during BAPI execution.
boolean	isEmpty()
Iterator<ResultElement>	iterator()
int	size()
String	toString()
boolean	wasSuccessful()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

BapiQueryResult

public BapiQueryResult()

Method Detail

hasSuccessMessages

public boolean hasSuccessMessages()

Indicates whether success messages occurred during BAPI execution.

hasInformationMessages

public boolean hasInformationMessages()

Indicates whether information messages occurred during BAPI execution.

hasWarningMessages

public boolean hasWarningMessages()

Indicates whether warning messages occurred during BAPI execution.

hasFailed

public boolean hasFailed()

Returns:

Checks whether the call failed, i.e. whether the result contains error messages.

wasSuccessful

public boolean wasSuccessful()

Returns:

Whether the BAPI query was successful.

hasErrorMessages

public boolean hasErrorMessages()

Returns:

Whether error messages occurred during BAPI execution.

size

public int size()

Returns:

The number of elements in the result.

isEmpty

public boolean isEmpty()

Returns:

Whether this result has any elements.

has

public boolean has(String elementName)

Indicates whether the element with the given name exists in the result.

Parameters:

elementName - The name of the element to be accessed.

getIfPresent

public com.google.common.base.Optional<ResultElement> getIfPresent(String elementName)
                                                            throws IllegalArgumentException

Returns the element with the given name from this result.

Parameters:

elementName - The name of the element to be accessed.

Returns:

If existing, an optional instance of ResultElement representing the corresponding element.

Throws:

IllegalArgumentException

get

public ResultElement get(int index)
                  throws IndexOutOfBoundsException

Returns the element with the given name from this result.

Parameters:

index - The index of the element to be accessed.

Returns:

An instance of ResultElement representing the corresponding element.

Throws:

IndexOutOfBoundsException - If the given index is out of bounds.

get

public ResultElement get(String elementName)
                  throws IllegalArgumentException

Returns the element with the given name from this result.

Parameters:

elementName - The name of the element to be accessed.

Returns:

An instance of ResultElement representing the corresponding element.

Throws:

IllegalArgumentException - If the element could not be found.

collect

public CollectedResultCollection collect(String elementName)

Collects the resulting elements with the given name from the parameters of this result.

Parameters:

elementName - The name of the nested elements to be collected.

Returns:

An instance of ResultCollection representing the corresponding elements.

getResultElements

public ArrayList<ResultElement> getResultElements()

Returns:

A list of all result elements.

iterator

public Iterator<ResultElement> iterator()

Specified by:

iterator in interface Iterable<ResultElement>

toString

@Generated(value="lombok")
public String toString()

Overrides:

toString in class Object

getQuery

@Generated(value="lombok")
public QueryT getQuery()

Description copied from interface: QueryResult

ERP query from which this result originates.

Specified by:

getQuery in interface QueryResult<QueryT extends Query<QueryT,QueryResultT>,QueryResultT extends com.sap.cloud.sdk.s4hana.connectivity.rfc.AbstractRemoteFunctionQueryResult<QueryT,QueryResultT>>

getSuccessMessages

@Generated(value="lombok")
public List<RemoteFunctionMessage> getSuccessMessages()

getInformationMessages

@Generated(value="lombok")
public List<RemoteFunctionMessage> getInformationMessages()

getWarningMessages

@Generated(value="lombok")
public List<RemoteFunctionMessage> getWarningMessages()

getErrorMessages

@Generated(value="lombok")
public List<RemoteFunctionMessage> getErrorMessages()