com.ocpsoft.pretty.faces.annotation

Annotation Type URLQueryParameter

@Retention(value=RUNTIME)
@Target(value=FIELD)
@Inherited
@Documented
public @interface URLQueryParameter

Defines a managed query parameter of the form http://site.com/url?key=somevalue, where if the parameter exists, the value will be injected into the annotated field. This also handles JSF commandLink and AJAX <f:param> values.

If the class containing the field is annotated with a URLMapping annotation, the query parameter will automatically be added to this mapping. You can also add the parameter to a foreign mapping by referencing it with the mappingId attribute.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value This is the request value key

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	mappingId Optional ID of the mapping to add this query parameter to.
boolean	onPostback Optional boolean (default true), if set to false, this query parameter will not be injected on form postbacks.

Element Detail

value

public abstract String value

This is the request value key

onPostback

public abstract boolean onPostback

Optional boolean (default true), if set to false, this query parameter will not be injected on form postbacks.

Default:

true

mappingId

public abstract String mappingId

Optional ID of the mapping to add this query parameter to. If no ID is given, the parameter will be added to the mapping specified on the class the annotated method belongs to.

Default:

""