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

Class ReadRequest

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

Direct Known Subclasses:

ReadRequestImpl

public abstract class ReadRequest
extends Request

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

Constructor Summary

Constructors

Constructor and Description
ReadRequest()

Method Summary

Modifier and Type	Method and Description
abstract void	addSelectProperties(List<String> selectProp) Adds properties to the $select system query option.
abstract List<String>	getExpandProperties() Gets the list of properties specified in the $expand system query option.
abstract Map<String,Object>	getKeys() Gets the keys of the entity to be read.
abstract List<String>	getSelectProperties() Gets the list of properties specified in the $select system query option.
abstract Map<String,Object>	getSourceKeys() Gets the keys of the parent entity specified in a navigation.

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

ReadRequest

public ReadRequest()

Method Detail

getKeys

public abstract Map<String,Object> getKeys()

Gets the keys of the entity to be read. For example, if the URL is /EPMSampleService/Products(1), then this method returns (ProductID,1). Let's look at another example of a URL where a child entity is specified in a navigation: /EPMSampleService/SalesOrders(1)/ToSalesOrderLineItems(1). In this case, this method returns (SalesOrderLineItemID, 1).

Returns:

A Map containing the keys of the entity

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(1), then this method returns (SalesOrderID,1).

Returns:

A Map containing the keys of the parent entity

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/Product(1)?$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

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