com.tplan.robot.scripting.commands
Interface ExtendedParamsObject

All Known Subinterfaces:

ParametrizedTestScript

All Known Implementing Classes:

ObjectSearchModule, SearchImageComparisonModule, SearchImageComparisonModule2, TesseractOCR, TextRecognitionComparisonModule

public interface ExtendedParamsObject

Allows objects created by commands such as image comparison modules or report providers declare parameters and support them through the handling command.

T-Plan Robot Enterprise, (C) 2009-2012 T-Plan Limited. All rights reserved.

Method Summary

String	getLongDescription() Get long description of the object - purpose, usage, parameter syntax etc.
List<String>	getParameters() Get the list of parameter names supported by the object implementing this interface.
List	getParameterValues(String parameterName) Get the list of acceptable values of a particular parameter (if known).
String	getShortDescription() Get short description which describes in a few words purpose and role of the object.
List<Preference>	getVisualParameters() Get the list of supported parameters encapsulated in Preference instances.
void	setParameters(Map<String,String> paramsAndValues) Set parameters and their values in the object.

Method Detail

getParameters

List<String> getParameters()

Get the list of parameter names supported by the object implementing this interface.

Returns:

list of supported parameter names.

getParameterValues

List getParameterValues(String parameterName)

Get the list of acceptable values of a particular parameter (if known). The method should return null for parameters which are not enumerated "one of" type.

Parameters:

parameterName - parameter name

Returns:

list of acceptable parameter values or null if the parameter value is not limited to a particular value set.

setParameters

void setParameters(Map<String,String> paramsAndValues)

Set parameters and their values in the object. It will be called by the command and the map will contain parameters parsed on the command line. Parsing of the parameter values should be performed in a way which is not case sensitive (for example through encapsulating the map through the CaseTolerantHashMap class);

Parameters:

paramsAndValues - map of parameters and their values.

getVisualParameters

List<Preference> getVisualParameters()

Get the list of supported parameters encapsulated in Preference instances. It allows to specify a larger set of parameter properties such as parameter name ("configuration key" in the Preferences object), label (short description), description, expected value type and optional value limits and relationships with other parameters. This allows the GUI to build and display the parameters in form of GUI components in command property dialogs and validate the values entered by users..

Returns:

list of supported parameters in form of Preference instances.

getShortDescription

String getShortDescription()

Get short description which describes in a few words purpose and role of the object. The text should be single line in plain text. This is optional and the method may return null. The short description is typically displayed by the GUI by the object name or ID.

Returns:

short object description.

getLongDescription

String getLongDescription()

Get long description of the object - purpose, usage, parameter syntax etc. The text may be multiline plain text or HTML with extended link syntax described in CustomHyperlinkListener. This is optional and the method may return null. The long description is typically displayed by the GUI when user selects to view details of the object.

Returns:

long object description.