PortletListener (Portlet 4.0 API Specification)

```
@Retention(RUNTIME)
@Target(TYPE)
public @interface PortletListener
```
Designates a portlet URL generation listener class. The listener method will be invoked before a URL of the corresponding type is generated.
The annotated method must implement the PortletListener interface.

Since:

3.0

See Also:

PortletURLGenerationListener

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element	Description
`LocaleString[]`	`description`	The portlet listener description providing locale-specific text describing the portlet listener for use by the portal application or by tools.
`LocaleString[]`	`displayName`	The display-name type contains a language-specific short name that is intended to be displayed by tools.
`String`	`listenerName`	The listener name.
`int`	`ordinal`	The ordinal number for this annotated method.

- Element Detail
  - listenerName
```
String listenerName
```
    The listener name.
    The listener name is not required. If a listener name is provided, the listener configuration may be addressed through the listener name in the portlet deployment descriptor to modify or remove the listener.
    
    Returns:
    
    The listener name
    
    Default:
    
    ""
- - ordinal
```
int ordinal
```
    The ordinal number for this annotated method.
    The ordinal number determines the order of execution if multiple methods are annotated for a given URL type. Annotated methods with a lower ordinal number are executed before methods with a higher ordinal number.
    
    Returns:
    
    The ordinal number
    
    Default:
    
    0
- - displayName
```
LocaleString[] displayName
```
    The display-name type contains a language-specific short name that is intended to be displayed by tools.
    
    Returns:
    
    The display name
    
    Default:
    
    {}
- - description
```
LocaleString[] description
```
    The portlet listener description providing locale-specific text describing the portlet listener for use by the portal application or by tools.
    
    Returns:
    
    The portlet description
    
    Default:
    
    {}