Matches when the current request carries a configured parameter, optionally with a specific value. Configured in asset type XML as the requestParam element inside a view mapping. If only a name is set, any request containing that parameter matches regardless of its value; if a value is also set, the parameter must equal it exactly. If no name is set, the matcher matches every request.
Group: Asset Types
Implements: AssetInteractionMatcher
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Human-readable description of this matcher, naming the required parameter and, if set, the required value, or noting that it matches all requests when no name is configured. Used to explain to an administrator when a view mapping applies. |
| name | String | The name of the request parameter this matcher looks for. May be null, in which case the matcher matches every request regardless of parameters. |
| value | String | The value the named request parameter must equal for a match. May be null, in which case the request only needs to contain the parameter, with any value, for a match. |
Methods
getName()
Returns: String
The name of the request parameter this matcher looks for. May be null, in which case the matcher matches every request regardless of parameters.
getValue()
Returns: String
The value the named request parameter must equal for a match. May be null, in which case the request only needs to contain the parameter, with any value, for a match.
getDescription()
Returns: String
Human-readable description of this matcher, naming the required parameter and, if set, the required value, or noting that it matches all requests when no name is configured. Used to explain to an administrator when a view mapping applies.