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

Class QueryResponseBuilderImpl

java.lang.Object

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

All Implemented Interfaces:

QueryResponseBuilder, ResponseBuilder

public class QueryResponseBuilderImpl
extends Object
implements QueryResponseBuilder

Constructor Summary

Constructors

Constructor and Description
QueryResponseBuilderImpl()

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) Deprecated.
QueryResponseBuilder	audit(EntityData auditEntityData, List<String> properties) Deprecated.
int	getCount()
QueryResponse	response() Returns an instance of QueryResponse object.
QueryResponseBuilder	setCount(int count)
QueryResponseBuilder	setData(List<?> data) 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> data) 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryResponseBuilderImpl

public QueryResponseBuilderImpl()

Method Detail

setDataAsMap

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

Description copied from interface: QueryResponseBuilder

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

Specified by:

setDataAsMap in interface QueryResponseBuilder

Parameters:

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

Returns:

A QueryResponseBuilder object containing the queried entities

setEntityData

public QueryResponseBuilder setEntityData(List<EntityData> data)

Description copied from interface: QueryResponseBuilder

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

Specified by:

setEntityData in interface QueryResponseBuilder

Parameters:

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

Returns:

A QueryResponseBuilder object containing the queried entities

setData

public QueryResponseBuilder setData(List<?> data)

Description copied from interface: QueryResponseBuilder

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

Specified by:

setData in interface QueryResponseBuilder

Parameters:

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

Returns:

A QueryResponseBuilder object containing the queried entities

addHeaders

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

Description copied from interface: QueryResponseBuilder

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.

Specified by:

addHeaders in interface QueryResponseBuilder

Parameters:

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

Returns:

A QueryResponseBuilder object containing the added headers

setHeader

public QueryResponseBuilder setHeader(String name,
                                      String value)

Description copied from interface: QueryResponseBuilder

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.

Specified by:

setHeader in interface QueryResponseBuilder

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

public QueryResponseBuilder addHeader(String name,
                                      String value)

Description copied from interface: QueryResponseBuilder

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.

Specified by:

addHeader in interface QueryResponseBuilder

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

response

public QueryResponse response()

Description copied from interface: QueryResponseBuilder

Returns an instance of QueryResponse object.

Specified by:

response in interface QueryResponseBuilder

Returns:

A QueryResponse object

audit

@Deprecated
public QueryResponseBuilder audit(boolean enable)

Deprecated.

Description copied from interface: QueryResponseBuilder

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

Specified by:

audit in interface QueryResponseBuilder

Parameters:

enable - A boolean to enable or disable auditing

Returns:

A QueryResponseBuilder object containing the updated auditing attribute

audit

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

Deprecated.

Description copied from interface: QueryResponseBuilder

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.

Specified by:

audit in interface QueryResponseBuilder

Parameters:

auditEntityData - 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

public QueryResponseBuilder setTopDone(boolean isTopDone)

Description copied from interface: QueryResponseBuilder

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

Specified by:

setTopDone in interface QueryResponseBuilder

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

public QueryResponseBuilder setSkipDone(boolean isSkipDone)

Description copied from interface: QueryResponseBuilder

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

Specified by:

setSkipDone in interface QueryResponseBuilder

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

public QueryResponseBuilder setInlineCount(int inlineCount)

Description copied from interface: QueryResponseBuilder

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

Specified by:

setInlineCount in interface QueryResponseBuilder

Parameters:

inlineCount - An integer that represents the custom inline count value

Returns:

A QueryResponseBuilder object containing this value

setCount

public QueryResponseBuilder setCount(int count)

Specified by:

setCount in interface QueryResponseBuilder

getCount

public int getCount()