com.sap.cloud.server.odata

Class QueryResult

java.lang.Object

com.sap.cloud.server.odata.QueryResult

public class QueryResult
extends java.lang.Object

Holds a data query and its result value. Allows conversion of the result to optional/required/list values for basic, complex and entity types.

Constructor Summary

Constructors

Constructor and Description
QueryResult(DataQuery query, DataValue result) See QueryResult(DataQuery, DataValue, int, DataServiceException).
QueryResult(DataQuery query, DataValue result, int status) See QueryResult(DataQuery, DataValue, int, DataServiceException).
QueryResult(DataQuery query, DataValue result, int status, DataServiceException error) Construct a new query result.

Method Summary

Modifier and Type	Method and Description
void	check() See check(int).
void	check(int fixOptions) Check if the QueryResult.result is valid with respect to the QueryResult.query.
DataValueList	getBasicList() Return the basic list for this result.
ComplexValueList	getComplexList() Return the complex list for this result.
long	getCount() Return the "count" for this result.
java.lang.String	getDeltaLink() Return (nullable) The "delta link" for this result.
DeltaStream	getDeltaStream() Return the delta stream for this result.
EntityValueList	getEntityList() Return the entity list for this result.
EntityStream	getEntityStream() Return the entity stream for this result.
DataServiceException	getError() Return (nullable) Error if status does not represent a successful response.
long	getInlineCount() Return the inline "total count" for this result.
java.lang.String	getNextLink() Return (nullable) The "next link" for this result.
DataQuery	getNextQuery() Return the "next query" for this result.
DataValue	getOptionalBasic() Return (nullable) The optional basic value of this result.
ComplexValue	getOptionalComplex() Return (nullable) The optional complex value of this result.
EntityValue	getOptionalEntity() Return (nullable) The optional entity value of this result.
DataQuery	getQuery() Return data query.
DataValue	getRequiredBasic() Return the required basic value of this result.
ComplexValue	getRequiredComplex() Return the required complex value of this result.
EntityValue	getRequiredEntity() Return the required entity value of this result.
DataValue	getResult() Return (nullable) Result value.
int	getStatus() Return result status (e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryResult

public QueryResult(DataQuery query,
                   DataValue result)

See QueryResult(DataQuery, DataValue, int, DataServiceException).

Parameters:

query - Query parameter.

result - Result parameter.

QueryResult

public QueryResult(DataQuery query,
                   DataValue result,
                   int status)

See QueryResult(DataQuery, DataValue, int, DataServiceException).

Parameters:

query - Query parameter.

result - Result parameter.

status - Status parameter.

QueryResult

public QueryResult(DataQuery query,
                   DataValue result,
                   int status,
                   DataServiceException error)

Construct a new query result.

Parameters:

query - Data query.

result - (nullable) Result value.

status - Result status (using HTTP status codes).

error - (nullable) Error, if the query failed, otherwise null.

Method Detail

check

public void check()

See check(int).

check

public void check(int fixOptions)

Check if the QueryResult.result is valid with respect to the QueryResult.query. A result will be considered invalid if it is missing properties that were expected according to the use of DataQuery.select or DataQuery.expand in the QueryResult.query.

Throws:

QueryResultException if the result is definitely not valid.

Parameters:

fixOptions - Flags for fixing invalid OData payload

getBasicList

public DataValueList getBasicList()

Return the basic list for this result.

Throws:

QueryResultException if the result does not have the expected type.

Returns:

The basic list for this result.

getComplexList

public ComplexValueList getComplexList()

Return the complex list for this result.

Throws:

QueryResultException if the result does not have the expected type.

Returns:

The complex list for this result.

getCount

public long getCount()

Return the "count" for this result.

Throws:

QueryResultException if the result does not have the expected type.

See Also:

DataQuery.count, Requesting the Number of Items in a Collection.

Returns:

The "count" for this result.

getDeltaLink

public java.lang.String getDeltaLink()

Return (nullable) The "delta link" for this result.

Throws:

QueryResultException if the result does not have the expected type.

See Also:

EntityValueList.deltaLink.

Returns:

(nullable) The "delta link" for this result.

getDeltaStream

public DeltaStream getDeltaStream()

Return the delta stream for this result.

Throws:

QueryResultException if the result does not have the expected type.

Returns:

The delta stream for this result.

getEntityList

public EntityValueList getEntityList()

Return the entity list for this result.

Throws:

QueryResultException if the result does not have the expected type.

Example using proxy classes:

 public void entityListExample() {
     NorthwindService service = this.getService();
     DataQuery query = new DataQuery()
         .select(Customer.customerID, Customer.companyName, Customer.contactName)
         .orderBy(Customer.companyName);
     Customer__List customers = service.getCustomers(query);
     for (Customer customer : customers) {
         this.showCustomer(customer);
     }
 }
 

Example using dynamic API:

 public void entityListExample() {
     DataService service = this.getService();
     EntitySet customersEntitySet = service.getEntitySet("Customers");
     EntityType customerEntityType = customersEntitySet.getEntityType();
     Property customerIDProperty = customerEntityType.getProperty("CustomerID");
     Property companyNameProperty = customerEntityType.getProperty("CompanyName");
     Property contactNameProperty = customerEntityType.getProperty("ContactName");
     DataQuery query = new DataQuery()
         .select(customerIDProperty, companyNameProperty, contactNameProperty)
         .from(customersEntitySet).orderBy(companyNameProperty);
     EntityValueList customers = service.executeQuery(query).getEntityList();
     for (EntityValue customer : customers) {
         this.showCustomer(customer);
     }
 }
 

Returns:

The entity list for this result.

getEntityStream

public EntityStream getEntityStream()

Return the entity stream for this result.

Throws:

QueryResultException if the result does not have the expected type.

Returns:

The entity stream for this result.

getError

public DataServiceException getError()

Return (nullable) Error if status does not represent a successful response.

Returns:

(nullable) Error if status does not represent a successful response.

getInlineCount

public long getInlineCount()

Return the inline "total count" for this result.

Throws:

QueryResultException if the result does not have an inline "total count".

See Also:

DataQuery.inlineCount, System Query Option $count.

Returns:

The inline "total count" for this result.

getNextLink

public java.lang.String getNextLink()

Return (nullable) The "next link" for this result.

Throws:

QueryResultException if the result does not have the expected type.

See Also:

EntityValueList.nextLink.

Returns:

(nullable) The "next link" for this result.

getNextQuery

public DataQuery getNextQuery()

Return the "next query" for this result. The query will have a non-null URL if this result includes a nextLink.

Throws:

QueryResultException if the result does not have the expected type.

See Also:

EntityValueList.nextLink.

Returns:

The "next query" for this result. The query will have a non-`null` URL if this result includes a nextLink.

getOptionalBasic

public DataValue getOptionalBasic()

Return (nullable) The optional basic value of this result.

Throws:

QueryResultException if the result does not have the expected type.

Returns:

(nullable) The optional basic value of this result.

getOptionalComplex

public ComplexValue getOptionalComplex()

Return (nullable) The optional complex value of this result.

Throws:

QueryResultException if the result does not have the expected type.

Returns:

(nullable) The optional complex value of this result.

getOptionalEntity

public EntityValue getOptionalEntity()

Return (nullable) The optional entity value of this result.

Throws:

QueryResultException if the result does not have the expected type.

Example using proxy classes:

 public void optionalEntityExample() {
     NorthwindService service = this.getService();
     DataQuery query = new DataQuery()
         .select(Customer.customerID, Customer.companyName, Customer.contactName)
         .orderBy(Customer.companyName).top(1);
     Customer customer = example.internal.Single_optional_Customer.from(service.getCustomers(query));
     if (customer != null) {
         this.showCustomer(customer);
     }
 }
 

Example using dynamic API:

 public void optionalEntityExample() {
     DataService service = this.getService();
     EntitySet customersEntitySet = service.getEntitySet("Customers");
     EntityType customerEntityType = customersEntitySet.getEntityType();
     Property customerIDProperty = customerEntityType.getProperty("CustomerID");
     Property companyNameProperty = customerEntityType.getProperty("CompanyName");
     Property contactNameProperty = customerEntityType.getProperty("ContactName");
     DataQuery query = new DataQuery()
         .select(customerIDProperty, companyNameProperty, contactNameProperty)
         .from(customersEntitySet).orderBy(companyNameProperty).top(1);
     EntityValue customer = service.executeQuery(query).getOptionalEntity();
     if (customer != null) {
         this.showCustomer(customer);
     }
 }
 

Returns:

(nullable) The optional entity value of this result.

getQuery

public DataQuery getQuery()

Return data query.

Returns:

Data query.

getRequiredBasic

public DataValue getRequiredBasic()

Return the required basic value of this result.

Throws:

QueryResultException if the result does not have the expected type.

Returns:

The required basic value of this result.

getRequiredComplex

public ComplexValue getRequiredComplex()

Return the required complex value of this result.

Throws:

QueryResultException if the result does not have the expected type.

Returns:

The required complex value of this result.

getRequiredEntity

public EntityValue getRequiredEntity()

Return the required entity value of this result.

Throws:

QueryResultException if the result does not have the expected type.

Example using proxy classes:

 public void requiredEntityExample() {
     NorthwindService service = this.getService();
     DataQuery query = new DataQuery()
         .select(Customer.customerID, Customer.companyName, Customer.contactName)
         .orderBy(Customer.companyName).top(1);
     Customer customer = service.getCustomer(query);
     this.showCustomer(customer);
 }
 

Example using dynamic API:

 public void requiredEntityExample() {
     DataService service = this.getService();
     EntitySet customersEntitySet = service.getEntitySet("Customers");
     EntityType customerEntityType = customersEntitySet.getEntityType();
     Property customerIDProperty = customerEntityType.getProperty("CustomerID");
     Property companyNameProperty = customerEntityType.getProperty("CompanyName");
     Property contactNameProperty = customerEntityType.getProperty("ContactName");
     DataQuery query = new DataQuery()
         .select(customerIDProperty, companyNameProperty, contactNameProperty)
         .from(customersEntitySet).orderBy(companyNameProperty).top(1);
     EntityValue customer = service.executeQuery(query).getRequiredEntity();
     this.showCustomer(customer);
 }
 

Returns:

The required entity value of this result.

getResult

public DataValue getResult()

Return (nullable) Result value.

Returns:

(nullable) Result value.

getStatus

public int getStatus()

Return result status (e.g. HTTP status code 200 = OK).

Returns:

Result status (e.g. HTTP status code 200 = OK).