To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Describes one parameter that can be substituted into a saved query, such as startDate or the currently selected organisations. Instances are built with newQueryParameterBuilder and registered so a query definition can list which parameters it accepts and how they should be presented to the user.
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | A longer, human-readable explanation of what this parameter represents, or null if none was set. |
| name | String | The unique name of this parameter, used as its key when substituting values into a query, for example "startDate" or "selectedOrgs". |
| optional | boolean | Whether a value for this parameter may be omitted when running a query. |
| title | String | The human-readable label for this parameter. Defaults to a de-camelised form of the name if no title was set on the builder. |
| type | String | The value type of this parameter, one of the QP_TYPE_* constants such as date, keyword or long. |
Methods
getName()
Returns: String
The unique name of this parameter, used as its key when substituting values into a query, for example "startDate" or "selectedOrgs".
getType()
Returns: String
The value type of this parameter, one of the QP_TYPE_* constants such as date, keyword or long.
getTitle()
Returns: String
The human-readable label for this parameter. Defaults to a de-camelised form of the name if no title was set on the builder.
getDescription()
Returns: String
A longer, human-readable explanation of what this parameter represents, or null if none was set.
isOptional()
Returns: boolean
Whether a value for this parameter may be omitted when running a query.
© 2025 Kademi Ltd