Top Description Methods
javax.portlet.annotations

public @Interface EventDefinition

extends Annotation
Annotations
@Retention:RUNTIME
@Target:ANNOTATION_TYPE
Imports
java.lang.annotation.Retention, .Target

This annotation is used within composite portlet configuration annotations to represent a single event. It cannot be used as a stand-alone portlet annotation.
Since
3.0

Method Summary

Modifier and TypeMethod and Description
public PortletQName[]

Returns:

the qualified name aliases
alias
()

The qualified name aliases for this event.
public LocaleString[]

Returns:

The event description
description
()

Provides locale-specific text describing the event for use by the portal application or by tools.
public LocaleString[]

Returns:

The display name
displayName
()

The display-name type contains a locale-specific short name that is intended to be displayed by tools.
public Class<?>

Returns:

A class representing the payload type
payloadType
()

The event payload type associated with the specified QName.
public PortletQName

Returns:

The event qname
qname
()

The event Qname.
Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

aliasback to summary
public PortletQName[] alias()

The qualified name aliases for this event.
Returns:PortletQName[]

the qualified name aliases

descriptionback to summary
public LocaleString[] description()

Provides locale-specific text describing the event for use by the portal application or by tools.
Returns:LocaleString[]

The event description

displayNameback to summary
public LocaleString[] displayName()

The display-name type contains a locale-specific short name that is intended to be displayed by tools. It is used by display-name elements. The display name need not be unique.
Returns:LocaleString[]

The display name

payloadTypeback to summary
public Class<?> payloadType()

The event payload type associated with the specified QName. Each QName may have only a single event payload type associated with it. The payload type must be serializable and must have a valid JAXB binding.

The default value void.class indicates that the event has no payload.

Returns:Class<?>

A class representing the payload type

See Also
javax.portlet.Event, javax.portlet.StateAwareResponse#setEvent(javax.xml.namespace.QName, java.io.Serializable), javax.portlet.StateAwareResponse#setEvent(String, java.io.Serializable)
qnameback to summary
public PortletQName qname()

The event Qname.

The local part of the QName should be a non-empty String. The local part is used as the event name in the portlet API event handling methods.

The event qname must be unique within the portlet application.

Returns:PortletQName

The event qname

See Also
javax.portlet.Event, javax.portlet.StateAwareResponse#setEvent(javax.xml.namespace.QName, java.io.Serializable), javax.portlet.StateAwareResponse#setEvent(String, java.io.Serializable), PortletConfig#getProcessingEventQNames, PortletConfig#getPublishingEventQNames