com.ibm.di.config.interfaces
Interface EventHandlerActionConfig

All Superinterfaces:

BaseConfiguration, Serializable

All Known Implementing Classes:

EventHandlerActionConfigImpl

public interface EventHandlerActionConfig
extends BaseConfiguration

Specifies the basic methods for configuring the action of an Event Handler

Field Summary

static int	ACTIONS_ERROR Constant, describing a type of action
static int	ACTIONS_FALSE Constant, describing a type of action
static int	ACTIONS_TRUE Constant, describing a type of action
static int	CONDITIONS Constant, describing a type of action

Fields inherited from interface com.ibm.di.config.interfaces.BaseConfiguration

DISABLE_EXTPROPS, DISABLE_INHERITANCE, INHERIT_NONE, INHERIT_PARENT, ONE_LEVEL, RECURSIVE, RECURSIVE_ONELEVEL, RECURSIVE_SUBTREE, SEARCH_EXACTCASE, SEARCH_ONELEVEL, SEARCH_PARAMNAME, SEARCH_PARAMNAME_RE, SEARCH_PROPERTY, SEARCH_REGEX, SUBTREE

Method Summary

EventHandlerActionItemConfig	addAction(int type, String command) Adds a feature to the Action attribute of the EventHandlerActionConfig object
EventHandlerConditionConfig	addCondition(boolean script) Adds a feature to the Condition attribute of the EventHandlerActionConfig object
Vector	getActions(int actionType) Gets the actions attribute of the EventHandlerActionConfig object
Vector	getConditions() Gets the conditions attribute of the EventHandlerActionConfig object
boolean	getConsumeEvent() Gets the consumeEvent attribute of the EventHandlerActionConfig object
boolean	getEnabled() Gets the enabled attribute of the EventHandlerActionConfig object
boolean	getMatchAnyCondition() Gets the matchAnyCondition attribute of the EventHandlerActionConfig object
void	moveAction(int type, int fromIndex, int toIndex) Move an action
void	removeAction(int type, int index) Remove an action
void	removeCondition(int index) Remove a Condition
void	setConsumeEvent(boolean consume) Sets the consumeEvent attribute of the EventHandlerActionConfig object
void	setEnabled(boolean enabled) Sets the enabled attribute of the EventHandlerActionConfig object
void	setMatchAnyCondition(boolean matchAny) Sets the matchAnyCondition attribute of the EventHandlerActionConfig object

Methods inherited from interface com.ibm.di.config.interfaces.BaseConfiguration

addListener, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, init, isParameterLocal, nameForChild, notifyChange, notifyChange, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten

Field Detail

ACTIONS_TRUE

static final int ACTIONS_TRUE

Constant, describing a type of action

See Also:

Constant Field Values

ACTIONS_FALSE

static final int ACTIONS_FALSE

Constant, describing a type of action

See Also:

Constant Field Values

ACTIONS_ERROR

static final int ACTIONS_ERROR

Constant, describing a type of action

See Also:

Constant Field Values

CONDITIONS

static final int CONDITIONS

Constant, describing a type of action

See Also:

Constant Field Values

Method Detail

getMatchAnyCondition

boolean getMatchAnyCondition()

Gets the matchAnyCondition attribute of the EventHandlerActionConfig object

Returns:

The matchAnyCondition value

setMatchAnyCondition

void setMatchAnyCondition(boolean matchAny)

Sets the matchAnyCondition attribute of the EventHandlerActionConfig object

Parameters:

matchAny - The new matchAnyCondition value

getEnabled

boolean getEnabled()

Gets the enabled attribute of the EventHandlerActionConfig object

Specified by:

getEnabled in interface BaseConfiguration

Returns:

The enabled value

setEnabled

void setEnabled(boolean enabled)

Sets the enabled attribute of the EventHandlerActionConfig object

Specified by:

setEnabled in interface BaseConfiguration

Parameters:

enabled - The new enabled value

getConsumeEvent

boolean getConsumeEvent()

Gets the consumeEvent attribute of the EventHandlerActionConfig object

Returns:

The consumeEvent value

setConsumeEvent

void setConsumeEvent(boolean consume)

Sets the consumeEvent attribute of the EventHandlerActionConfig object

Parameters:

consume - The new consumeEvent value

getActions

Vector getActions(int actionType)

Gets the actions attribute of the EventHandlerActionConfig object

Parameters:

actionType - The type of the action

Returns:

Returns a list of EventHandlerActionItemConfig objects

getConditions

Vector getConditions()

Gets the conditions attribute of the EventHandlerActionConfig object

Returns:

Returns a list of EventHandlerActionItemConfig objects.

addAction

EventHandlerActionItemConfig addAction(int type,
                                       String command)

Adds a feature to the Action attribute of the EventHandlerActionConfig object

Parameters:

type - The feature to be added to the Action attribute

command - The feature to be added to the Action attribute

Returns:

Object, describing the action in case of such type of action

removeAction

void removeAction(int type,
                  int index)

Remove an action

Parameters:

type - The type of action

index - The position of the object, describing the action

moveAction

void moveAction(int type,
                int fromIndex,
                int toIndex)

Move an action

Parameters:

type - The type of action

fromIndex - The position from which to take the action object

toIndex - The new position of the action object

addCondition

EventHandlerConditionConfig addCondition(boolean script)

Adds a feature to the Condition attribute of the EventHandlerActionConfig object

Parameters:

script - The feature to be added to the Condition attribute

Returns:

An EventHandlerConditionConfig object

removeCondition

void removeCondition(int index)

Remove a Condition

Parameters:

index - The position of the object, describing the condition