com.ibm.mashups.enabler.widget
Interface ModifiableEventProvider

All Superinterfaces:

com.ibm.mashups.enabler.DirtyFlagProvider, EventProvider

public ModifiableEventProvider
extends EventProvider, com.ibm.mashups.enabler.DirtyFlagProvider

Interface for a modifiable widget event provider.

Since:

2.4

Method Summary

Event	createEvent(String name, boolean handled) Creates an Event with the given name.
ModifiableEvent[]	getEvents(unknown filter) Returns wigdet events.
ModifiableEvent	getEvent(String name) Returns the event identified by name or null if the event doesn't exist in this provider.
void	addEvent(Event event) Adds an Event to this EventProvider .
void	removeEvent(Event event) Removes an Event from this EventProvider .
boolean	confirmAddEvent(Event event) Indicates if the specified event may be added.
boolean	confirmRemoveEvent(Event event) Indicates if the given event may be removed.

Methods inherited from interface com.ibm.mashups.enabler.widget.EventProvider

getEvents, getEvent, getEventByID

Method Detail

createEvent

Event createEvent(String name,
                  boolean handled)

Creates an Event with the given name.

Parameters:

name - the name of the event

handled - if true the created event will be "handled", otherwiseit will be "published"

Returns:

the newly created event with name

getEvents

ModifiableEvent[] getEvents(unknown filter)

Returns wigdet events.

Returns:

widget events

getEvent

ModifiableEvent getEvent(String name)

Returns the event identified by name or null if the event doesn't exist in this provider.

Parameters:

name - the name of the Event .

Returns:

the event identified by name or null.

addEvent

void addEvent(Event event)

Adds an Event to this EventProvider . If the event already exists it will be overwritten, otherwise it will be added.

Parameters:

event - the event to add to this event provider

removeEvent

void removeEvent(Event event)

Removes an Event from this EventProvider .

Parameters:

event - the event to add to this event provider

confirmAddEvent

boolean confirmAddEvent(Event event)

Indicates if the specified event may be added.

Parameters:

event - the event to add

Returns:

true in case the event may be added, false otherwise

confirmRemoveEvent

boolean confirmRemoveEvent(Event event)

Indicates if the given event may be removed.

Parameters:

event - the event to remove

Returns:

true in case the preference may be removed, false otherwise