org.torweg.pulse.annotations
Annotation Type Action

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

defines the action (see Command.getAction()) which triggers the annotated method of a Controller.

Methods annotated with @Action can have a return type of either null, Result or any JAXB enabled Object. Allowed method Parameters are Bundle, ServiceRequest and any class annotated with @RequestBean or nay combination thereof.

Version:

$Revision: 1954 $

Author:

Thomas Weber

See Also:

Controller, Command

Required Element Summary

java.lang.String

value the name of the action.

Optional Element Summary

boolean	generate shall the CommandGenerator include this Action as a generated Command; default false.
Action.Security	security shall the generated Command use a secure connection (if available); default Action.Security.KEEP.
boolean	stripSitemapID shall the sitemap ID be stripped from the generated Command, if generate() is true; default true.
boolean	stripSuffix shall the suffix be stripped from the generated Command, if generate() is true; default false.
boolean	uploadAllowed shall multipart/form-data based uploads be allowed for the Action ; default false.

Element Detail

value

public abstract java.lang.String value

the name of the action.

See Also:

Command.getAction()

generate

public abstract boolean generate

shall the CommandGenerator include this Action as a generated Command; default false.

Default:

false

security

public abstract Action.Security security

shall the generated Command use a secure connection (if available); default Action.Security.KEEP.

Default:

KEEP

stripSitemapID

public abstract boolean stripSitemapID

shall the sitemap ID be stripped from the generated Command, if generate() is true; default true.

Default:

true

stripSuffix

public abstract boolean stripSuffix

shall the suffix be stripped from the generated Command, if generate() is true; default false.

Default:

false

uploadAllowed

public abstract boolean uploadAllowed

shall multipart/form-data based uploads be allowed for the Action ; default false.

Default:

false