com.ibm.carma.ui.events
Interface IParameterValidator


public interface IParameterValidator

Interface for parameter validators. Clients should implement this interface and include the name of their class in a parameter validator contributed to the parameter validators extension point "com.ibm.carma.ui.parameterValidators". For example, the markup in the contributing plugin.xml might contain:

 <extension point="com.ibm.carma.ui.parameterValidators">
   <parameterValidator
     parameterId="042"
     actionId="21"
     ramId="42"
     class="com.example.MyParameterValidator"/>
 </extension>
 

Since:
8.0

Method Summary
 ValidationResult validateParameter(ParameterValidationEvent event)
          This method is invoked when the action dialog needs to determine whether the user has input appropriate parameters for the action to continue.
 void verifyInput(ParameterValidationEvent event)
          This method is invoked when the value of the parameter is about to be modified.
 

Method Detail

verifyInput

void verifyInput(ParameterValidationEvent event)
This method is invoked when the value of the parameter is about to be modified. The parameter validation event occurs after the user has done something to modify the value (typically typed a key), but before the value is modified. The allowInput field in the parameter validation event indicates whether or not to modify the value.

Parameters:
event - An event containing information about the input operation.

validateParameter

ValidationResult validateParameter(ParameterValidationEvent event)
This method is invoked when the action dialog needs to determine whether the user has input appropriate parameters for the action to continue.

Parameters:
event - An event containing information about the input operation.
Returns:
A validation result including a message to display to the user, or null to clear the message.