com.ibm.portal.portletmodel
Interface PublishingEventDefinition

All Superinterfaces:

CommunicationEndpoint, CommunicationSource, Identifiable, Localized

public interface PublishingEventDefinition
extends CommunicationSource

Interface for a communication source that is a JSR 286 event definition. This matches to a <supported-publishing-event> element in a JSR 286 deployment descriptor.

Since:

6.1.0.0

Field Summary

static java.lang.String

ENDPOINT_PREFIX This prefix is used to construct the name of this PublishingEventDefinition.

Method Summary

java.lang.String

getName() Returns the name of this publishing event definition.

Methods inherited from interface com.ibm.portal.portletmodel.CommunicationEndpoint

getDatatype

Methods inherited from interface com.ibm.portal.Localized

getDescription, getLocales, getTitle

Methods inherited from interface com.ibm.portal.Identifiable

getObjectID

Field Detail

ENDPOINT_PREFIX

static final java.lang.String ENDPOINT_PREFIX

This prefix is used to construct the name of this PublishingEventDefinition.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns the name of this publishing event definition. It is constructed by the concatenation of ENDPOINT_PREFIX and the string representation of this endpoint´s CommunicationDatatype.getQName() The name must be unique within the scope of a portlet and can be used to uniquely refer to this endpoint.

Specified by:

getName in interface CommunicationEndpoint

Returns:

The publishing event definition´s name.