org.apache.cocoon.portal.event
Interface EventConverter

All Superinterfaces:

Component

All Known Implementing Classes:

DefaultEventConverter, PageLabelEventConverter

public interface EventConverter
extends Component

Convert events from and into strings

Version:

CVS $Id: EventConverter.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Carsten Ziegeler, Volker Schmitt

Field Summary

static String

ROLE

Method Summary

Event	decode(String value) Decode an event This is used to "activate" events using a link
String	encode(Event event) Encode an event.
void	finish() This notifies the converter that an event processing phase ends
boolean	isMarshallEvents() Returns true if events are not to be returned as request parameters
void	start() This notifies the converter that a new event processing phase starts

Field Detail

ROLE

static final String ROLE

Method Detail

encode

String encode(Event event)

Encode an event. This is used to "activate" events using a link

Parameters:

event - The event to encode

Returns:

A unique string representation for this event

decode

Event decode(String value)

Decode an event This is used to "activate" events using a link

Parameters:

value - The string representation created using encode(Event)

Returns:

The event or null

start

void start()

This notifies the converter that a new event processing phase starts

finish

void finish()

This notifies the converter that an event processing phase ends

isMarshallEvents

boolean isMarshallEvents()

Returns true if events are not to be returned as request parameters