Package jakarta.portlet.annotations

Annotation Type EventDefinition

@Retention(RUNTIME)
@Target(ANNOTATION_TYPE)
public @interface EventDefinition

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

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
PortletQName	qname	The event Qname.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
PortletQName[]	alias	The qualified name aliases for this event.
LocaleString[]	description	Provides locale-specific text describing the event for use by the portal application or by tools.
LocaleString[]	displayName	The display-name type contains a locale-specific short name that is intended to be displayed by tools.
Class<?>	payloadType	The event payload type associated with the specified QName.

Element Detail

qname

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:

The event qname

See Also:

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

payloadType

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:

A class representing the payload type

See Also:

Event, StateAwareResponse.setEvent(javax.xml.namespace.QName, java.io.Serializable), StateAwareResponse.setEvent(String, java.io.Serializable)

Default:

void.class

description

LocaleString[] description

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

Returns:

The event description

Default:

{}

displayName

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:

The display name

Default:

{}

alias

PortletQName[] alias

The qualified name aliases for this event.

Returns:

the qualified name aliases

Default:

{}