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

Class QueryRequestImpl

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

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

public class QueryRequestImpl
extends QueryRequest

Constructor Summary

Constructors

Constructor and Description
QueryRequestImpl(RequestContext requestContext, String entityName, EntityMetadata entityMetadata, Map<String,List<String>> headers, String httpMethod)

Method Summary

Modifier and Type	Method and Description
void	addSelectProperties(List<String> selectedProperties) Adds properties to the $select system query option.
Map<String,String>	getCustomQueryOptions() Gets the custom query options specified in the URL.
List<String>	getExpandProperties() Gets the list of properties specified in the $expand system query option.
ExpressionBuilder	getExpressionBuilder() Gets the ExpressionBuilder object with which you can create your own filter expressions.
List<OrderByExpression>	getOrderByProperties() Gets the list of properties specified in the $orderby system query option.
Expression	getQueryExpression() Gets the filter expression tree from the Query request.
Object	getQueryExpressionInternal()
List<String>	getSelectProperties() Gets the list of properties specified in the $select system query option.
int	getSkipOptionValue() Gets the value specified in the $skip system query option.
Map<String,Object>	getSourceKeys() Gets the keys of the parent entity specified in a navigation.
int	getTopOptionValue() Gets the value specified in the $top system query option.
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
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).
void	setCountCall(boolean countCall)
void	setCustomQueryOptions(Map<String,String> customQueryOptions)
void	setExpandItems(String expandItems)
void	setIsInlineCount(boolean isInlineCount)
void	setOrderByOption(OrderByExpression orderByOptions)
void	setQueryExpression(Expression expression)
void	setSelectItems(String selectItems)
void	setSkipOption(int skipValue)
void	setSourceEntityName(String sourceEntityName)
void	setSourceKeys(Map<String,Object> sourceKeys)
void	setTopOption(int topValue)

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

QueryRequestImpl

public QueryRequestImpl(RequestContext requestContext,
                        String entityName,
                        EntityMetadata entityMetadata,
                        Map<String,List<String>> headers,
                        String httpMethod)

Method Detail

getSourceKeys

public Map<String,Object> getSourceKeys()

Description copied from class: QueryRequest

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).

Specified by:

getSourceKeys in class QueryRequest

Returns:

A Map containing the keys of the parent entity

setSourceEntityName

public void setSourceEntityName(String sourceEntityName)

setSourceKeys

public void setSourceKeys(Map<String,Object> sourceKeys)

setTopOption

public void setTopOption(int topValue)

getTopOptionValue

public int getTopOptionValue()

Description copied from class: QueryRequest

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

Specified by:

getTopOptionValue in class QueryRequest

Returns:

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

getSkipOptionValue

public int getSkipOptionValue()

Description copied from class: QueryRequest

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

Specified by:

getSkipOptionValue in class QueryRequest

Returns:

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

setSkipOption

public void setSkipOption(int skipValue)

setOrderByOption

public void setOrderByOption(OrderByExpression orderByOptions)

getOrderByProperties

public List<OrderByExpression> getOrderByProperties()

Description copied from class: QueryRequest

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.

Specified by:

getOrderByProperties in class QueryRequest

Returns:

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

setSelectItems

public void setSelectItems(String selectItems)

getSelectProperties

public List<String> getSelectProperties()

Description copied from class: QueryRequest

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.

Specified by:

getSelectProperties in class QueryRequest

Returns:

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

setCustomQueryOptions

public void setCustomQueryOptions(Map<String,String> customQueryOptions)

getCustomQueryOptions

public Map<String,String> getCustomQueryOptions()

Description copied from class: QueryRequest

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.

Specified by:

getCustomQueryOptions in class QueryRequest

Returns:

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

setCountCall

public void setCountCall(boolean countCall)

isCountCall

public boolean isCountCall()

Description copied from class: QueryRequest

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

Specified by:

isCountCall in class QueryRequest

Returns:

A boolean representing if it is a $count call

getQueryExpression

public Expression getQueryExpression()

Description copied from class: QueryRequest

Gets the filter expression tree from the Query request.

Specified by:

getQueryExpression in class QueryRequest

Returns:

An Expression object representing the filter expression tree

getQueryExpressionInternal

public Object getQueryExpressionInternal()

getExpressionBuilder

public ExpressionBuilder getExpressionBuilder()

Description copied from class: QueryRequest

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

Specified by:

getExpressionBuilder in class QueryRequest

Returns:

An ExpressionBuilder object

setQueryExpression

public void setQueryExpression(Expression expression)

addSelectProperties

public void addSelectProperties(List<String> selectedProperties)

Description copied from class: QueryRequest

Adds properties to the $select system query option.

Specified by:

addSelectProperties in class QueryRequest

Parameters:

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

setIsInlineCount

public void setIsInlineCount(boolean isInlineCount)

isInlineCountCall

public boolean isInlineCountCall()

Description copied from class: QueryRequest

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.

Specified by:

isInlineCountCall in class QueryRequest

Returns:

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

setExpandItems

public void setExpandItems(String expandItems)

getExpandProperties

public List<String> getExpandProperties()

Description copied from class: QueryRequest

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.

Specified by:

getExpandProperties in class QueryRequest

Returns:

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