Fluent builder for a QueryParameter, created via QueryParameter.newQueryParameterBuilder with the parameter's name and type, then configured with an optional title, description and optional flag before calling build.

Group: Builders


Methods

build(List<QueryParameter> list)

Returns: QueryParameter

Builds the QueryParameter from this builder's configured values. If no title was set, it is derived from the parameter's name. If a list is given, the built parameter is appended to it.

ParameterDescription
lista list to append the built parameter to, or null to skip appending

title(String s)

Returns: QueryParameterBuilder

Sets the human-readable display title for the parameter being built.

ParameterDescription
sthe display title to use

description(String s)

Returns: QueryParameterBuilder

Sets the longer, human-readable description for the parameter being built.

ParameterDescription
sthe description to use

optional(boolean s)

Returns: QueryParameterBuilder

Sets whether the parameter being built may be omitted when running a query.

ParameterDescription
strue if the parameter is optional, false if it must be supplied
To get full access to the Kademi Hub existing customers can login here, or new customers can register here.