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

Interface QueryResponseBuilder

All Superinterfaces:

ResponseBuilder

All Known Implementing Classes:

QueryResponseBuilderImpl

public interface QueryResponseBuilder
extends ResponseBuilder

Provides the methods for creating a response, populating its header and content, and enabling audit logging in the case of a successful query operation.

Method Summary

Modifier and Type	Method and Description
QueryResponseBuilder	addHeader(String name, String value) Adds a header with the specified name and value in the QueryResponseBuilder object.
QueryResponseBuilder	addHeaders(Map<String,List<String>> headers) Adds headers in the QueryResponseBuilder object.
QueryResponseBuilder	audit(boolean enable) Enables auditing for query operation.
QueryResponseBuilder	audit(EntityData entityData, List<String> properties) Deprecated.
QueryResponse	response() Returns an instance of QueryResponse object.
QueryResponseBuilder	setCount(int count)
QueryResponseBuilder	setData(List<?> pojoList) Sets a list of POJO objects representing the entities returned by the query operation in the QueryResponseBuilder object.
QueryResponseBuilder	setDataAsMap(List<Map<String,Object>> data) Sets a list of key-value pairs representing the properties of entities returned by the query operation in the QueryResponseBuilder object.
QueryResponseBuilder	setEntityData(List<EntityData> entityDataList) Sets a list of EntityData objects representing the entities returned by the query operation in the QueryResponseBuilder object.
QueryResponseBuilder	setHeader(String name, String value) Sets a header with the specified name and value in the QueryResponseBuilder object.
QueryResponseBuilder	setInlineCount(int inlineCount) Sets a custom inline count value that overrides the default value returned in the response.
QueryResponseBuilder	setSkipDone(boolean isSkipDone) Indicates that there is a custom implementation of the $skip system query option.
QueryResponseBuilder	setTopDone(boolean isTopDone) Indicates that there is a custom implementation of the $top system query option.

Method Detail

addHeaders

QueryResponseBuilder addHeaders(Map<String,List<String>> headers)

Adds headers in the QueryResponseBuilder object. If headers are already present in the QueryResponseBuilder object, the specified headers are added to the existing ones. The header name is case-insensitive. Note: The SDK framework might overwrite the values you add to the header in the final response that gets created.

Parameters:

headers - A java.util.Map> containing the headers to be added

Returns:

A QueryResponseBuilder object containing the added headers

setDataAsMap

QueryResponseBuilder setDataAsMap(List<Map<String,Object>> data)

Sets a list of key-value pairs representing the properties of entities returned by the query operation in the QueryResponseBuilder object.

Parameters:

data - A List of Map objects that represents the queried entities

Returns:

A QueryResponseBuilder object containing the queried entities

setEntityData

QueryResponseBuilder setEntityData(List<EntityData> entityDataList)

Sets a list of EntityData objects representing the entities returned by the query operation in the QueryResponseBuilder object.

Parameters:

entityDataList - A List of EntityData objects that represents the queried entities

Returns:

A QueryResponseBuilder object containing the queried entities

setData

QueryResponseBuilder setData(List<?> pojoList)

Sets a list of POJO objects representing the entities returned by the query operation in the QueryResponseBuilder object.

Parameters:

pojoList - A List of POJO objects that represents the queried entities

Returns:

A QueryResponseBuilder object containing the queried entities

setHeader

QueryResponseBuilder setHeader(String name,
                               String value)

Sets a header with the specified name and value in the QueryResponseBuilder object. If the header is already present in the QueryResponseBuilder object, the new value overwrites the previous one. The header name is case-insensitive. Note: The SDK framework might overwrite the value you set in the header in the final response that gets created.

Parameters:

name - A String containing the name of the header

value - A String containing the header value

Returns:

A QueryResponseBuilder object containing the newly added or updated header

addHeader

QueryResponseBuilder addHeader(String name,
                               String value)

Adds a header with the specified name and value in the QueryResponseBuilder object. If the header is already present in the QueryResponseBuilder object, the specified value is added to the existing values. The header name is case-insensitive. Note: The SDK framework might overwrite the value you add to the header in the final response that gets created.

Parameters:

name - A String containing the name of the header

value - A String containing the additional header value

Returns:

A QueryResponseBuilder object containing the additional header

audit

QueryResponseBuilder audit(boolean enable)

Enables auditing for query operation. Please note that auditing is disabled by default.

Parameters:

enable - A boolean to enable or disable auditing

Returns:

A QueryResponseBuilder object containing the updated auditing attribute

audit

@Deprecated
QueryResponseBuilder audit(EntityData entityData,
                                       List<String> properties)

Deprecated.

Specifies the entity and its properties for which auditing must be done in the case of a query operation. Please note that auditing must be enabled before calling this method.

Parameters:

entityData - An EntityData object to be audited

properties - A List of String objects containing the properties to be audited

Returns:

A QueryResponseBuilder object containing the entity and its properties to be audited

setTopDone

QueryResponseBuilder setTopDone(boolean isTopDone)

Indicates that there is a custom implementation of the $top system query option. This overrides the default implementation of this option.

Parameters:

isTopDone - A boolean to indicate that there is a custom implementation of the $top system query option

Returns:

A QueryResponseBuilder object containing this flag

setSkipDone

QueryResponseBuilder setSkipDone(boolean isSkipDone)

Indicates that there is a custom implementation of the $skip system query option. This overrides the default implementation of this option.

Parameters:

isSkipDone - A boolean to indicate that there is a custom implementation of the $skip system query option

Returns:

A QueryResponseBuilder object containing this flag

setInlineCount

QueryResponseBuilder setInlineCount(int inlineCount)

Sets a custom inline count value that overrides the default value returned in the response.

Parameters:

inlineCount - An integer that represents the custom inline count value

Returns:

A QueryResponseBuilder object containing this value

response

QueryResponse response()

Returns an instance of QueryResponse object.

Returns:

A QueryResponse object

setCount

QueryResponseBuilder setCount(int count)