Package com.sap.cds.services.request

Interface ModifiableParameterInfo

All Superinterfaces:

ParameterInfo

public interface ModifiableParameterInfo
extends ParameterInfo

Interface to modify the values of the ParameterInfo used in a RequestContext.

Method Summary

Modifier and Type	Method	Description
ModifiableParameterInfo	setCorrelationId(String correlationId)	Sets the correlation ID for the request.
ModifiableParameterInfo	setHeader(String id, String value)	Sets the value of the header with the given identifier.
ModifiableParameterInfo	setHeaders(Map<String,String> headers)	Sets all the header values.
ModifiableParameterInfo	setLocale(Locale locale)	Sets the Locale of the request.
ModifiableParameterInfo	setQueryParameter(String key, String value)	Sets the value of the query parameter with the given key.
ModifiableParameterInfo	setQueryParameters(Map<String,String> queryParamters)	Sets all the query parameters.
ModifiableParameterInfo	setValidAt(Instant validAt)	Sets the "valid-at" time stamp for the request.
ModifiableParameterInfo	setValidFrom(Instant validFrom)	Sets the "valid-from" time stamp for the request.
ModifiableParameterInfo	setValidTo(Instant validTo)	Sets the "valid-to" time stamp for the request.

Methods inherited from interface com.sap.cds.services.request.ParameterInfo

copy, getCorrelationId, getHeader, getHeaders, getLocale, getQueryParameter, getQueryParams, getValidFrom, getValidTo

Method Details

setHeader

ModifiableParameterInfo setHeader(String id,
 String value)

Sets the value of the header with the given identifier.

Parameters:

id - the header identifier.

value - the value of the header.

Returns:

the same ModifiableParameterInfo instance

setHeaders

ModifiableParameterInfo setHeaders(Map<String,String> headers)

Sets all the header values.

Parameters:

headers - the headers.

Returns:

the same ModifiableParameterInfo instance

setQueryParameter

ModifiableParameterInfo setQueryParameter(String key,
 String value)

Sets the value of the query parameter with the given key.

Parameters:

key - the query parameter key.

value - the value of the query parameter.

Returns:

the same ModifiableParameterInfo instance

setQueryParameters

ModifiableParameterInfo setQueryParameters(Map<String,String> queryParamters)

Sets all the query parameters.

Parameters:

queryParamters - the map of query parameters.

Returns:

the same ModifiableParameterInfo instance

setLocale

ModifiableParameterInfo setLocale(Locale locale)

Sets the Locale of the request.

Parameters:

locale - the preferred Locale set by the request.

Returns:

the same ModifiableParameterInfo instance

setValidFrom

ModifiableParameterInfo setValidFrom(Instant validFrom)

Sets the "valid-from" time stamp for the request.

Parameters:

validFrom - the Instant for valid from time stamp.

Returns:

the same ModifiableParameterInfo instance

setValidTo

ModifiableParameterInfo setValidTo(Instant validTo)

Sets the "valid-to" time stamp for the request.

Parameters:

validTo - the Instant for valid to time stamp.

Returns:

the same ModifiableParameterInfo instance

setValidAt

ModifiableParameterInfo setValidAt(Instant validAt)

Sets the "valid-at" time stamp for the request. This is a utility method, which sets corresponding values on setValidFrom(Instant) and setValidTo(Instant)

Parameters:

validAt - the Instant for valid at time stamp.

Returns:

the same ModifiableParameterInfo instance

setCorrelationId

ModifiableParameterInfo setCorrelationId(String correlationId)

Sets the correlation ID for the request.

Parameters:

correlationId - the correlation ID.

Returns:

the same ModifiableParameterInfo instance