com.canto.cumulus.server.esp.modules.trigger

Interface ActionESP

All Superinterfaces:

BaseESP

public interface ActionESP
extends BaseESP

This interface describes the functions a server ESP needs to provide to be accepted as a trigger action ESP which will be called when a supported trigger condition is met.

Method Summary

Methods

Modifier and Type	Method and Description
ActionConfigurator	createConfigurator() Called by the Properties dialog within the Cumulus Client application to configure the action part of a trigger.
ActionExecutor	getActionExecutor(int condition) Returns the actual executor for the given condition.
JPack	getData() Returns the configuration data.
java.lang.String	getName(int language) Returns the ESPs name for the given language.
int[]	getSupportedConditions() Returns the conditions this ESP supports.
void	setData(JPack actionData) Sets the configuration data for a specific trigger action.

Methods inherited from interface com.canto.cumulus.server.esp.modules.BaseESP

getID

Method Detail

getName

java.lang.String getName(int language)

Returns the ESPs name for the given language.

Parameters:

language - language ID

Returns:

ESPs name

getSupportedConditions

int[] getSupportedConditions()

Returns the conditions this ESP supports. The possible values are ConditionTypes.CONDITION_TYPE_CATALOG_SETTINGS_CHANGED, ConditionTypes.CONDITION_TYPE_FIELD_VALUE_CHANGED, ConditionTypes.CONDITION_TYPE_RECORD_CATEGORY_ADDED and ConditionTypes.CONDITION_TYPE_RECORD_CATEGORY_DELETED.

Returns:

an int[] of supported condition IDs

getActionExecutor

ActionExecutor getActionExecutor(int condition)

Returns the actual executor for the given condition. This method gets called when a trigger condition has met and the action needs to be run now.

Parameters:

condition - the condition type hit

Returns:

the action to execute now

setData

void setData(JPack actionData)

Sets the configuration data for a specific trigger action.

Parameters:

actionData - the configuration data for an instance of this action attached to a configured trigger

getData

JPack getData()

Returns the configuration data.

Returns:

configuration for this action instance

See Also:

setData(com.canto.cumulus.utils.JPack)

createConfigurator

ActionConfigurator createConfigurator()

Called by the Properties dialog within the Cumulus Client application to configure the action part of a trigger.

Returns:

configurator for the action