com.bea.wsrp.model.events
Interface IHandledEvent

All Superinterfaces

Serializable

public interface IHandledEvent
extends Serializable

Holds information about an event handled by a portlet.

This interface is intended to be implemented only by Oracle Weblogic Portal. Oracle Systems reserves the right to add abstract methods to this interface without notice. Implementations of this interface by other parties must not be expected to compile without change in future versions of Oracle Weblogic Portal.

Method Summary

List<QName>	getAliases() Returns a list of per-portlet aliases for the event, if aliases were specified per-portlet.
ILocalizedString	getDescription() Returns a description of the event.
List<IEventHandler>	getEventHandlers() Returns event handlers
String	getEventLabel() Returns a label for the event
QName	getEventName() Returns the WSRP V1 name of the event.
QName	getEventQName() Returns the WSRP V2 name of the event if WSRP V2 is being used.
QName	getEventType() Returns the type of the event for WSRP V1 events; returns null for WSRP V2 events.
String	getPortalEventType() Returns the portal event type (onMinimize, onEdit, onInit, etc.) of this event if it is a portal event.
String	getSourceDefinitionLabels() Returns an immutable list of source definition labels that this is event is valid for.
String	getSourceDefinitionWildcard() Returns the wild card used for source definition labels.
boolean	isFilterable() Returns true if this svent is filterble.
boolean	isFromSelfInstanceOnly() Returns true if this event should be handled only when the source of the event is an instance of this portlet.
boolean	isOnlyIfDisplayed() Returns true if this event should be handled only when the portlet is rendered in a page.

Method Detail

getEventName

QName getEventName()

Returns the WSRP V1 name of the event. For WSRP V2 event names, use the getEventQName() method.

Returns

The WSRP V1 name for the event. Returns null for WSRP V2 events.

getEventQName

QName getEventQName()

Returns the WSRP V2 name of the event if WSRP V2 is being used.

Returns

the QName of the event, or null if not a WSRP V2 event.

getAliases

List<QName> getAliases()

Returns a list of per-portlet aliases for the event, if aliases were specified per-portlet.

Returns

null if no per-portlet aliases were specified, an empty list if there are no aliases for this portlet, or the per-portlet list of aliases for this portlet event.

getDescription

ILocalizedString getDescription()

Returns a description of the event.

Returns

description

getEventType

QName getEventType()

Returns the type of the event for WSRP V1 events; returns null for WSRP V2 events.

Returns

type

getEventLabel

String getEventLabel()

Returns a label for the event

Returns

label

getEventHandlers

List<IEventHandler> getEventHandlers()

Returns event handlers

Returns

handlers

isFilterable

boolean isFilterable()

Returns true if this svent is filterble.

Returns

filterable

isOnlyIfDisplayed

boolean isOnlyIfDisplayed()

Returns true if this event should be handled only when the portlet is rendered in a page.

Returns

boolean

getSourceDefinitionLabels

String getSourceDefinitionLabels()

Returns an immutable list of source definition labels that this is event is valid for.

Returns

list

getSourceDefinitionWildcard

String getSourceDefinitionWildcard()

Returns the wild card used for source definition labels.

Returns

wildcard (this or any)

isFromSelfInstanceOnly

boolean isFromSelfInstanceOnly()

Returns true if this event should be handled only when the source of the event is an instance of this portlet.

Returns

boolean

getPortalEventType

String getPortalEventType()

Returns the portal event type (onMinimize, onEdit, onInit, etc.) of this event if it is a portal event.

Returns

the portal event type if a portal event, or null if not specified or available.