org.pentaho.platform.api.action
Interface IPreProcessingAction
- All Superinterfaces:
- IAction
public interface IPreProcessingAction
- extends IAction
Allows an Action to do some preliminary work prior to execution. This API also allows an Action
to fail early and thereby not actually execute. Typically this is used in combination with
IDefinitionAwareAction
to verify that the required inputs are provided prior to execution.
- Since:
- 3.6
- Author:
- aphillips
- See Also:
IAction
,
IDefinitionAwareAction
Method Summary |
void |
doPreExecution()
This method is called on an Action just prior to execution. |
Methods inherited from interface org.pentaho.platform.api.action.IAction |
execute |
doPreExecution
void doPreExecution()
throws ActionPreProcessingException
- This method is called on an Action just prior to execution. An Action can fail
early for any reason here by throwing an exception. If an exception is thrown here,
actual execution of the Action will not occur. If you need to do pre-execution validation
of inputs, see
IDefinitionAwareAction
- Throws:
ActionPreProcessingException
- if the Action is not able to proceed with execution