com.ocpsoft.pretty.faces.annotation

Annotation Type URLAction

@Retention(value=RUNTIME)
@Target(value=METHOD)
@Inherited
@Documented
public @interface URLAction

Specifies an action method to be called after URL parameters have been parsed and assigned into beans.

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

You can use URLActions as a container if you want to add multiple URLAction annotations to a single method.

Author:

Christian Kaltepoth

See Also:

URLMapping, URLActions

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	inheritable Whether child mappings inherit this action or not.
String	mappingId Optional ID of the mapping to add this action to.
boolean	onPostback Optional boolean (default true), if set to false, this action method will not occur on form postback.
URLAction.PhaseId	phaseId URLAction.PhaseId value (default after RESTORE_VIEW) if set to a valid JSF PhaseId, the action will occur immediately before the specified Phase (or immediately after RESTORE_VIEW).

Element Detail

mappingId

public abstract String mappingId

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

Default:

""

onPostback

public abstract boolean onPostback

Optional boolean (default true), if set to false, this action method will not occur on form postback.

Default:

true

phaseId

public abstract URLAction.PhaseId phaseId

URLAction.PhaseId value (default after RESTORE_VIEW) if set to a valid JSF PhaseId, the action will occur immediately before the specified Phase (or immediately after RESTORE_VIEW).

Note however, that if the phase does not occur, neither will your action method.

If ANY_PHASE is specified, the action method will fire on EVERY phase.

Default:

com.ocpsoft.pretty.faces.annotation.URLAction.PhaseId.RESTORE_VIEW

inheritable

public abstract boolean inheritable

Whether child mappings inherit this action or not.

Default:

false