com.sap.cloud.sdk.service.prov.api.request

Class QueryRequest

java.lang.Object

com.sap.cloud.sdk.service.prov.api.request.GenericRequest

com.sap.cloud.sdk.service.prov.api.request.Request

com.sap.cloud.sdk.service.prov.api.request.QueryRequest

Direct Known Subclasses:

QueryRequestImpl

public abstract class QueryRequest
extends Request

Provides the request information for querying an entity in a service.

Constructor Summary

Constructors

Constructor and Description
QueryRequest()

Method Summary

Modifier and Type	Method and Description
abstract void	addSelectProperties(List<String> selectProp) Adds properties to the $select system query option.
abstract Map<String,String>	getCustomQueryOptions() Gets the custom query options specified in the URL.
abstract List<String>	getExpandProperties() Gets the list of properties specified in the $expand system query option.
abstract ExpressionBuilder	getExpressionBuilder() Gets the ExpressionBuilder object with which you can create your own filter expressions.
abstract List<OrderByExpression>	getOrderByProperties() Gets the list of properties specified in the $orderby system query option.
abstract Expression	getQueryExpression() Gets the filter expression tree from the Query request.
abstract List<String>	getSelectProperties() Gets the list of properties specified in the $select system query option.
abstract int	getSkipOptionValue() Gets the value specified in the $skip system query option.
abstract Map<String,Object>	getSourceKeys() Gets the keys of the parent entity specified in a navigation.
abstract int	getTopOptionValue() Gets the value specified in the $top system query option.
abstract boolean	isCountCall() Returns true when it is a $count call(Only return the number of records.) For example, if the URL is /EPMSampleService/SalesOrders/$count then this method returns true
abstract boolean	isInlineCountCall() Indicates whether there is a $inlinecount=allpages or $count=true system query option in the request (depending on OData V2 or OData V4).

Methods inherited from class com.sap.cloud.sdk.service.prov.api.request.Request

getEntityName, getSourceEntityName

Methods inherited from class com.sap.cloud.sdk.service.prov.api.request.GenericRequest

containsHeader, getEntityMetadata, getHeader, getHeaderNames, getHeaders, getHttpMethod, getLocale, getMessageContainer, getRequestContext, getServiceName, setServiceName

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryRequest

public QueryRequest()

Method Detail

getSourceKeys

public abstract Map<String,Object> getSourceKeys()

Gets the keys of the parent entity specified in a navigation. For example, if the URL is /EPMSampleService/SalesOrders(1)/ToSalesOrderLineItems, then this method returns (SalesOrderID,1).

Returns:

A Map containing the keys of the parent entity

getTopOptionValue

public abstract int getTopOptionValue()

Gets the value specified in the $top system query option. For example, if the URL is /EPMSampleService/Products?$top=1, then the value returned by this method is 1. if top option value is not specified in the URL then the value returned by this method is -1

Returns:

An int representing the value in the $top system query option

getCustomQueryOptions

public abstract Map<String,String> getCustomQueryOptions()

Gets the custom query options specified in the URL. For example, if the URL is /EPMSampleService/Products?Search="abc", then the method returns a Map containing the value (Search,"abc"). If custom query option is not specified in the URL, then the value returned by this method is null.

Returns:

A Map containing the key value pair of the specified custom query options

getSkipOptionValue

public abstract int getSkipOptionValue()

Gets the value specified in the $skip system query option. For example, if the URL is /EPMSampleService/Products?$skip=1, then the value returned by this method is 1. if skip option value is not specified in the URL then the value returned by this method is -1

Returns:

An int representing the value in the $skip system query option

getOrderByProperties

public abstract List<OrderByExpression> getOrderByProperties()

Gets the list of properties specified in the $orderby system query option. For example, if the URL is /EPMSampleService/Products?$orderby=Category desc, then the property of the expression returned is Category and the sorting order is descending.

Returns:

A List of OrderByExpression objects containing the properties and their corresponding sorting order

getSelectProperties

public abstract List<String> getSelectProperties()

Gets the list of properties specified in the $select system query option. For example, if the URL is /EPMSampleService/Products?$select=Category, then the property of the entity set returned by this method is Category. Please note that if the system query option used in the URL is $select=*, then this method returns an empty list.

Returns:

A List of String objects containing the properties specified in $select expression

isCountCall

public abstract boolean isCountCall()

Returns true when it is a $count call(Only return the number of records.) For example, if the URL is /EPMSampleService/SalesOrders/$count then this method returns true

Returns:

A boolean representing if it is a $count call

isInlineCountCall

public abstract boolean isInlineCountCall()

Indicates whether there is a $inlinecount=allpages or $count=true system query option in the request (depending on OData V2 or OData V4). For example, if the URL is /manageProducts/GuidTestHC?$inlinecount=allpages then this method returns true or if the URL is /manageProducts/GuidTestHC?$inlinecount=none then this method returns false.

Returns:

A boolean indicating whether there is a $inlinecount=allpages or $count=true system query option in the request

getQueryExpression

public abstract Expression getQueryExpression()

Gets the filter expression tree from the Query request.

Returns:

An Expression object representing the filter expression tree

getExpressionBuilder

public abstract ExpressionBuilder getExpressionBuilder()

Gets the ExpressionBuilder object with which you can create your own filter expressions.

Returns:

An ExpressionBuilder object

addSelectProperties

public abstract void addSelectProperties(List<String> selectProp)

Adds properties to the $select system query option.

Parameters:

selectProp - A list of strings representing the properties to be added

getExpandProperties

public abstract List<String> getExpandProperties()

Gets the list of properties specified in the $expand system query option. For example, if the URL is /EPMSampleService/Product(1)?$expand=Category, then the property of the entity set returned by this method is Category.

Returns:

A List of String objects containing the properties specified in $expand expression