org.apache.jetspeed.events

Interface ProcessEvent

All Superinterfaces:

javax.portlet.Event

public interface ProcessEvent
extends javax.portlet.Event

ProcessEvent extends the Portlet API Event to give Jetspeed internals access to processing status as well other state information necessary to the internal implementation.

Version:

$Id: ProcessEvent.java 755263 2009-03-17 14:23:52Z ate $

Author:

David Sean Taylor

Method Summary

Methods

Modifier and Type	Method and Description
String	getClassName() Retrieve the class name of the serializable class that represents the Portlet Event.
org.apache.pluto.container.PortletWindow	getPortletWindow() Retrieve the portlet window associated with this event.
Serializable	getRawValue() Retrieve the raw value of the event class instance.
boolean	isProcessed() Indicates whether an event has been processed by the portal, or is queued to be processed.
void	setProcessed(boolean processed) Sets the current event status to processed.

Methods inherited from interface javax.portlet.Event

getName, getQName, getValue

Method Detail

setProcessed

void setProcessed(boolean processed)

Sets the current event status to processed. Should be called when the event is fully processed.

Parameters:

processed - Use this boolean to set the processed flag to either true or false.

isProcessed

boolean isProcessed()

Indicates whether an event has been processed by the portal, or is queued to be processed.

Returns:

The processed status of this event

getPortletWindow

org.apache.pluto.container.PortletWindow getPortletWindow()

Retrieve the portlet window associated with this event.

Returns:

The portlet window

getClassName

String getClassName()

Retrieve the class name of the serializable class that represents the Portlet Event.

Returns:

The class name of the event

getRawValue

Serializable getRawValue()

Retrieve the raw value of the event class instance. This is necessary to provide an alternative to kicking off the deserialziation process, if you just need the 'raw' value of the event

Returns:

the raw value of the event without deserializing the event