netcharts.server.api
Interface NDSPostProcessorInterfaceParameterInfo

All Known Subinterfaces:

NDSPostProcessorInterfaceParameterInfoV2

public interface NDSPostProcessorInterfaceParameterInfo

Field Summary

static int	CUSTOM CUSTOM parameter type.
static int	OPTION OPTION parameter type.
static int	TEXT TEXT parameter type.

Method Summary

java.lang.String	getDefaultValue() Returns the default value of the parameter.
java.lang.String	getDescription() Returns a description of the parameter.
java.lang.String	getDisplayName() Returns a descriptive version of the Process Module parameter.
java.lang.String[]	getOptionValues() Returns the set of possible values if the parameter is of type OPTION.
java.lang.String	getParameter() Returns the Process Module parameter.
int	getType() Returns the parameter type, either TEXT, OPTION or CUSTOM.
NDSPostProcessorInterfaceParameterValidator	getValidator() Returns a NDSPostProcessorInterfaceParameterValidator implementation that can be used to validate the currently entered value of the parameter.
boolean	removeParameterIfEmpty() Instructs NetCharts Designer to remove the parameter from the set if an empty value is entered.

Field Detail

TEXT

public static final int TEXT

TEXT parameter type. Specifies that the parameter expects a String value.

OPTION

public static final int OPTION

OPTION parameter type. Specifies that the parameter will be a String value based on a set of specified values.

CUSTOM

public static final int CUSTOM

CUSTOM parameter type. Specifies that the parameter will be configured via a custom class specified by the getCustomConfigurationClass method.

Method Detail

getType

public int getType()

Returns the parameter type, either TEXT, OPTION or CUSTOM.

Returns:

The parameter type, either TEXT, OPTION or CUSTOM.

getParameter

public java.lang.String getParameter()

Returns the Process Module parameter. This value would be the actual parameter that is expected by the Process Module.

Returns:

The name of the parameter.

getDisplayName

public java.lang.String getDisplayName()

Returns a descriptive version of the Process Module parameter. This value will be used in the Process Module Editor for the parameter.

Returns:

The descriptive name of the parameter.

getDescription

public java.lang.String getDescription()

Returns a description of the parameter.

Returns:

A description of the parameter.

getDefaultValue

public java.lang.String getDefaultValue()

Returns the default value of the parameter. If the parameter is of type TEXT, then the default value can be any String value. If the parameter is of type OPTION, then the default value should be one of the possible values. If null is returned, an empty string will be used.

Returns:

The default value of the parameter.

getOptionValues

public java.lang.String[] getOptionValues()

Returns the set of possible values if the parameter is of type OPTION. No value within the array should be null.

Returns:

String[] containing the set of possible values if the parameter is of type OPTION.

removeParameterIfEmpty

public boolean removeParameterIfEmpty()

Instructs NetCharts Designer to remove the parameter from the set if an empty value is entered.

Returns:

true to remove the parameter is an empty value, false otherwise.

getValidator

public NDSPostProcessorInterfaceParameterValidator getValidator()

Returns a NDSPostProcessorInterfaceParameterValidator implementation that can be used to validate the currently entered value of the parameter. If null, then no validation is performed.

Returns:

A NDSPostProcessorInterfaceParameterValidator implementation to perform validation.