Top Description Methods
javax.portlet.annotations

public @Interface ActionMethod

extends Annotation
Annotations
@Retention:RUNTIME
@Target:METHOD
Imports
java.lang.annotation.Retention, .Target
Designates a method corresponding to the portlet API processAction method. The annotated method must have the following signature:

public void <methodName>(ActionRequest, ActionResponse)

where the method name can be freely selected.

The method declaration may contain a throws clause. Exceptions declared in the throws clause should be of type javax.portlet.PortletException or java.io.IOException. Checked exceptions of any other type will be caught, wrapped with a PortletException, and rethrown.

Since
3.0
See Also
processAction

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The action name
actionName()

The action name.
public String

Returns:

The portlet name
portletName()

The portlet name for the annotated method.
public PortletQName[]

Returns:

The processing event QNames
publishingEvents()

The QName definitions of the events published by this method.
Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

actionNameback to summary
public String actionName()

The action name.

If an action name is specified, the bean enabler will dispatch Action requests with matching values of the reserved "javax.portlet.action" parameter to this method.

An ActionMethod with an empty action name will receive all Action requests not dispatched to other named ActionMethods.

Returns:String

The action name

portletNameback to summary
public String portletName()

The portlet name for the annotated method.
Returns:String

The portlet name

publishingEventsback to summary
public PortletQName[] publishingEvents()

The QName definitions of the events published by this method.
Returns:PortletQName[]

The processing event QNames

See Also
EventDefinition, PortletQName