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

Interface OperationResponseBuilder

All Superinterfaces:

ResponseBuilder

All Known Implementing Classes:

OperationResponseBuilderImpl

public interface OperationResponseBuilder
extends ResponseBuilder

Method Summary

Modifier and Type	Method and Description
OperationResponseBuilder	addHeader(String name, String value) Adds a header with the specified name and value in the OperationResponseBuilder object.
OperationResponseBuilder	addHeaders(Map<String,List<String>> headers) Adds headers in the OperationResponseBuilder object.
OperationResponse	response() Use this method to build the OperationResponse from the builder.
OperationResponseBuilder	setComplexData(List<Map<String,Object>> complexData) Can be used to set the response Complex Types, Array of ComplexTypes.
OperationResponseBuilder	setData(List<Object> data) Can be used to set the response Entity, Array of Entities where the entity is represented by a POJO.
OperationResponseBuilder	setEntityData(List<EntityData> entityData) Can be used to set the response Entity, Array of Entities.
OperationResponseBuilder	setHeader(String name, String value) Sets a header with the specified name and value in the OperationResponseBuilder object.
OperationResponseBuilder	setPrimitiveData(List<Object> primitiveData) Can be used to set the response single primitive type or collection of primitive types.

Method Detail

setData

OperationResponseBuilder setData(List<Object> data)

Can be used to set the response Entity, Array of Entities where the entity is represented by a POJO. If returning a single entity, create a list with a single POJO. If returning a collection of entities, create a list of POJOs.

Parameters:

A - single or array of Java objects.

Returns:

OperationResponseBuilder to build the response

setEntityData

OperationResponseBuilder setEntityData(List<EntityData> entityData)

Can be used to set the response Entity, Array of Entities. If returning a single entity, create a list with single element. If returning a collection of entities, create a list of entities.

Parameters:

A - single or array of EntityData

Returns:

OperationResponseBuilder to build the response

setComplexData

OperationResponseBuilder setComplexData(List<Map<String,Object>> complexData)

Can be used to set the response Complex Types, Array of ComplexTypes. If returning a single complex type, create a list with single Map. If returning a collection of complex types, create a list of complex type maps.

Parameters:

A - single or array of Complex Types

Returns:

OperationResponseBuilder to build the response

setPrimitiveData

OperationResponseBuilder setPrimitiveData(List<Object> primitiveData)

Can be used to set the response single primitive type or collection of primitive types. If returning a single primitive type, create a list with single primitive type. If returning a collection of primitive types, create a list of primitive types.

Parameters:

A - single or array of Primitive type Objects

Returns:

OperationResponseBuilder to build the response

addHeaders

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

Adds headers in the OperationResponseBuilder object. If headers are already present in the OperationResponseBuilder 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 OperationResponseBuilder object containing the added headers

setHeader

OperationResponseBuilder setHeader(String name,
                                   String value)

Sets a header with the specified name and value in the OperationResponseBuilder object. If the header is already present in the OperationResponseBuilder 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 OperationResponseBuilder object containing the newly added or updated header

addHeader

OperationResponseBuilder addHeader(String name,
                                   String value)

Adds a header with the specified name and value in the OperationResponseBuilder object. If the header is already present in the OperationResponseBuilder 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 OperationResponseBuilder object containing the additional header

response

OperationResponse response()

Use this method to build the OperationResponse from the builder.

Returns:

OperationResponse which can be returned