org.eclipse.stardust.engine.api.runtime

Interface EventHandlerBinding

All Superinterfaces:

Serializable

public interface EventHandlerBinding
extends Serializable

Client view of the binding state of an event handler. It can be used to retrieve or modify the binding state of the event handler.

The binding state can be retrieved and modified only for event handlers which has been defined as bindable in the model.

Version:

$Revision$

Author:

ubirkemeyer

Method Summary

Methods

Modifier and Type	Method and Description
Map	getAllAttributes() Gets all the attributes of the event handler binding.
List	getAllBindActions() Gets all event bindings corresponding to the bind actions defined for this event handler.
List	getAllEventActions() Gets all event bindings corresponding to the event actions defined for this event handler.
Map	getAllTypeAttributes() Gets all the attributes of the event handler type.
List	getAllUnbindActions() Gets all event bindings corresponding to the unbind actions defined for this event handler.
Object	getAttribute(String name) Gets an attribute.
EventActionBinding	getBindAction(String id) Gets the event binding corresponding to the specified bind action.
EventActionBinding	getEventAction(String id) Gets the event binding corresponding to the specified event action.
EventHandler	getHandler() Gets the event handler associated with this binding object.
Object	getTypeAttribute(String name) Gets an attribute of the event handler type.
EventActionBinding	getUnbindAction(String id) Gets the event binding corresponding to the specified unbind action.
boolean	isBound() Gets whether the event handler is bound (activated) or not.
Object	removeAttribute(String name) Removes an attribute.
Object	setAttribute(String name, Object value) Sets the value of an attribute.

Method Detail

removeAttribute

Object removeAttribute(String name)

Removes an attribute.

Parameters:

name - the name of the attribute.

Returns:

the value of the removed attribute.

setAttribute

Object setAttribute(String name,
                  Object value)

Sets the value of an attribute.

Parameters:

name - the name of the attribute.

value - the new value of the attribute.

Returns:

the previous value of the attribute, or null if the attribute didn't exist.

getAllAttributes

Map getAllAttributes()

Gets all the attributes of the event handler binding.

Returns:

a modifiable Map of attributes.

getAllTypeAttributes

Map getAllTypeAttributes()

Gets all the attributes of the event handler type.

Returns:

an unmodifiable Map of attributes.

getTypeAttribute

Object getTypeAttribute(String name)

Gets an attribute of the event handler type.

Parameters:

name - the name of the attribute.

Returns:

the value of the attribute.

getAllEventActions

List getAllEventActions()

Gets all event bindings corresponding to the event actions defined for this event handler. These are the actions that are executed when the event is handled.

Returns:

a List of EventActionBinding.

getAllBindActions

List getAllBindActions()

Gets all event bindings corresponding to the bind actions defined for this event handler. These are the actions that are executed when the event handler is bound (activated).

Returns:

a List of EventActionBinding.

getAllUnbindActions

List getAllUnbindActions()

Gets all event bindings corresponding to the unbind actions defined for this event handler. These are the actions performed when the event handler is unbound (deactivated).

Returns:

a List of EventActionBinding.

getHandler

EventHandler getHandler()

Gets the event handler associated with this binding object.

Returns:

the associated event handler.

getAttribute

Object getAttribute(String name)

Gets an attribute.

Parameters:

name - the name of the attribute.

Returns:

the value of the attribute.

getEventAction

EventActionBinding getEventAction(String id)

Gets the event binding corresponding to the specified event action.

Parameters:

id - the name of the event action.

Returns:

the corresponding event action binding.

getBindAction

EventActionBinding getBindAction(String id)

Gets the event binding corresponding to the specified bind action.

Parameters:

id - the name of the bind action.

Returns:

the corresponding event binding.

getUnbindAction

EventActionBinding getUnbindAction(String id)

Gets the event binding corresponding to the specified unbind action.

Parameters:

id - the name of the unbind action.

Returns:

the corresponding event binding.

isBound

boolean isBound()

Gets whether the event handler is bound (activated) or not.

Returns:

true if the event handler is bound.