Package com.funnelback.publicui.search.model.curator.action

Interface GroovyActionInterface

public interface GroovyActionInterface

Interface representing a curator action which can be implemented in an external Groovy class (to be subsequently used from within GroovyAction).

Method Summary

Modifier and Type	Method	Description
void	performAction(SearchTransaction searchTransaction, Action.Phase phase, java.util.Map<java.lang.String,java.lang.Object> properties)	Perform the desired action by modifying the passed searchTransaction.
boolean	runsInPhase(Action.Phase phase, java.util.Map<java.lang.String,java.lang.Object> properties)

Method Detail

runsInPhase

boolean runsInPhase(Action.Phase phase,
                    java.util.Map<java.lang.String,java.lang.Object> properties)

Parameters:

phase - The phase in which the action will be run (if true is returned).

properties - Any additional properties specified with the action.

Returns:

true if this action should run in the given phase and false otherwise.

performAction

void performAction(SearchTransaction searchTransaction,
                   Action.Phase phase,
                   java.util.Map<java.lang.String,java.lang.Object> properties)

Perform the desired action by modifying the passed searchTransaction.

Parameters:

searchTransaction - The searchTranscation being processed.

phase - The phase in which this action is currently being performed.

properties - Any additional properties specified with the action.