de.innovationgate.wgpublisher.webtml.portlet

Class PortletEvent

java.lang.Object

de.innovationgate.wgpublisher.webtml.portlet.PortletEvent

All Implemented Interfaces:

java.io.Serializable

public class PortletEvent
extends java.lang.Object
implements java.io.Serializable

Represents a portlet event

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PortletEvent	LOGIN_REQUIRED_EVENT
static PortletEvent	SESSION_IS_NEW_EVENT

Constructor Summary

Constructors

Constructor and Description
PortletEvent(java.lang.String name, de.innovationgate.wga.common.beans.csconfig.v1.Version compliance) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(java.lang.String name, java.lang.Object value) Add a parameter to the event
long	getIndex() Returns the index of the events in the user sessions event queue
java.lang.String	getIndexStr() Returns a string representation of the event index
java.lang.String	getName() Returns the name of the event
java.lang.Object	getParameter(java.lang.String name) Retrieves the value of an event parameter
java.lang.String	getSource() Returns the portletKey of the portlet which fired the event might be 'null' on system events
java.lang.String	getSourceName() Returns the name of the portlet that fired the event
java.lang.String	getTargetPortletKey() Returns a portlet key of the portlet for which this event was specifically fired.
int	hashCode()
void	setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)
void	setSource(java.lang.String source) Sets the portlet key of the portlet that fired the event
void	setSourceName(java.lang.String sourceName) Sets the name of the portlet that fired the evente
void	setTargetPortletKey(java.lang.String targetPortletKey) Sets a portlet key of the portlet for which this event was specifically fired.
java.lang.String	toJavaScriptObject() Exports the event data to Javascript code

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

SESSION_IS_NEW_EVENT

public static final PortletEvent SESSION_IS_NEW_EVENT

LOGIN_REQUIRED_EVENT

public static final PortletEvent LOGIN_REQUIRED_EVENT

Constructor Detail

PortletEvent

public PortletEvent(java.lang.String name,
            de.innovationgate.wga.common.beans.csconfig.v1.Version compliance)

Constructor. Just for internal WGA use.

Parameters:

name - Name of the event

compliance - Compliance of the originating WGA design

Method Detail

addParameter

public void addParameter(java.lang.String name,
                java.lang.Object value)

Add a parameter to the event

Parameters:

name - parameter name

value - parameter value

getParameter

public java.lang.Object getParameter(java.lang.String name)

Retrieves the value of an event parameter

Parameters:

name - Name of the parameter

getName

public java.lang.String getName()

Returns the name of the event

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toJavaScriptObject

public java.lang.String toJavaScriptObject()

Exports the event data to Javascript code

getSource

public java.lang.String getSource()

Returns the portletKey of the portlet which fired the event might be 'null' on system events

setSource

public void setSource(java.lang.String source)

Sets the portlet key of the portlet that fired the event

getSourceName

public java.lang.String getSourceName()

Returns the name of the portlet that fired the event

setSourceName

public void setSourceName(java.lang.String sourceName)

Sets the name of the portlet that fired the evente

getIndex

public long getIndex()

Returns the index of the events in the user sessions event queue

getIndexStr

public java.lang.String getIndexStr()

Returns a string representation of the event index

getTargetPortletKey

public java.lang.String getTargetPortletKey()

Returns a portlet key of the portlet for which this event was specifically fired. Is null if this is a global event.

setTargetPortletKey

public void setTargetPortletKey(java.lang.String targetPortletKey)

Sets a portlet key of the portlet for which this event was specifically fired.

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)