org.ikasan.framework.flow.event.service
Interface FlowEventJob

All Known Implementing Classes:

LoggingEventJob, WiretapEventJob

public interface FlowEventJob

Interface for objects that respond to Flow events

Author:

Ikasan Development Team

Method Summary

void	execute(String location, String moduleName, String flowName, Event event, Map<String,String> params) Execute the Flow Event Job
List<String>	getParameters() Returns a List of all specifiable parameters that will be respected when passed in on execute
Map<String,String>	validateParameters(Map<String,String> params) Validates a map of parameters that may be later used as arguments to the the execute method

Method Detail

execute

void execute(String location,
             String moduleName,
             String flowName,
             Event event,
             Map<String,String> params)

Execute the Flow Event Job

Parameters:

location - - The location of the FlowEvent

moduleName - - The name of the module

flowName - - The name of the flow

event - - The Event

params - - The parameters for the Job

getParameters

List<String> getParameters()

Returns a List of all specifiable parameters that will be respected when passed in on execute

Returns:

List of parameter names

validateParameters

Map<String,String> validateParameters(Map<String,String> params)

Validates a map of parameters that may be later used as arguments to the the execute method

Parameters:

params - - The parameters to validate

Returns:

Map of validation errors, error messages mapped by parameterNames may be null or empty if validation passes