to.etc.domui.annotations

Annotation Type UIUrlParameter

@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface UIUrlParameter

Valid for a page property, this defines an URL parameter that is to be filled in when the page is accessed. When the page is constructed the framework will scan for properties having this annotation. It will then inject the value obtained from the URL parameter specified in this property into the page.

Author:

Frits Jalvingh Created on Dec 19, 2008

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>	entity When set this defines that the given parameter is the primary key for this entity.
boolean	mandatory By default all parameters defined are mandatory.
String	name The name of the URL parameter to look for.

Element Detail

name

public abstract String name

The name of the URL parameter to look for. If this is not present we use the property's name as the name of the URL parameter.

Returns:

Default:

"$*$"

mandatory

public abstract boolean mandatory

By default all parameters defined are mandatory. Set this to false to make the URL parameter an optional value. When a value is optional it's setter is NOT called when the URL parameter is not present.

Returns:

Default:

true

entity

public abstract Class<?> entity

When set this defines that the given parameter is the primary key for this entity.

Returns:

Default:

java.lang.Object.class