org.adroitlogic.ultraesb.api.template

Annotation Type TemplateParam

@Documented
@Target(value=FIELD)
@Retention(value=RUNTIME)
public @interface TemplateParam

Annotation used to mark a field of a class annotated with the MediationTemplate annotation, as a template parameter. These are fed at the runtime based on the user configuration

Since:

2.0.0

Author:

Ruwan

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
InputControl	control The HTML form input control used to identify the input control used for the parameter
String	description Template parameter description used in user interface rendering
String	label The label of the template parameter
int	order The order in which the templates are ordered in the user interface
String	placeHolder Placeholder for the template parameter value
String	regex The regular expression that is used to validates the parameter value
String[]	rendering User interface rendering additional properties such as styles or HTML css classes
boolean	required Whether this parameter is required to successfully execute the template
String[]	values Possible values that can be specified as the values for the template parameter

Element Detail

control

public abstract InputControl control

The HTML form input control used to identify the input control used for the parameter

Returns:

the input control of the template

See Also:

InputControl

Default:

org.adroitlogic.ultraesb.api.template.InputControl.AUTO

label

public abstract String label

The label of the template parameter

Returns:

the label of the template parameter

Default:

""

description

public abstract String description

Template parameter description used in user interface rendering

Returns:

the template parameter description

Default:

""

placeHolder

public abstract String placeHolder

Placeholder for the template parameter value

Returns:

the parameter placeholder

Default:

""

values

public abstract String[] values

Possible values that can be specified as the values for the template parameter

Returns:

the accepted values

Default:

{}

rendering

public abstract String[] rendering

User interface rendering additional properties such as styles or HTML css classes

Returns:

the additional HTML element properties

Default:

{}

order

public abstract int order

The order in which the templates are ordered in the user interface

Returns:

the order of the parameter where the lessor once comes before the higher once

Default:

0

required

public abstract boolean required

Whether this parameter is required to successfully execute the template

Returns:

the indicator whether this parameter is required

Default:

true

regex

public abstract String regex

The regular expression that is used to validates the parameter value

Returns:

the regular expression that validates this parameter

Default:

".*"