org.qubership.automation.itf.core.util.annotation

Annotation Type Parameter

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface Parameter

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description Property placeholder in UI.
String	longName How the property would be displayed in UI.
String	shortName How the property would be stored in ConnectionProperties.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	fileDirectoryType TODO: Add JavaDoc.
boolean	forServer Is the property can be configured on server?.
boolean	forTemplate Is the property can be configured on template?.
boolean	forTrigger Is the property can be configured on trigger?.
boolean	fromServer Property can be configured only from environment.
boolean	isDynamic It's mean that property would be processed by TemplateEngine.
boolean	isRedefined TODO: Add JavaDoc.
boolean	loadTemplate Loading template by ID.
boolean	optional Is the value mandatory and must be filled?.
int	order TODO: Add JavaDoc.
String	uiCategory The category of the parameter to be displayed on the UI.
boolean	userSettings Create modifications from user configuration like envs.
String	validatePattern Expression that is used to validate the property on the UI.

Element Detail

shortName

public abstract String shortName

How the property would be stored in ConnectionProperties.

longName

public abstract String longName

How the property would be displayed in UI.

description

public abstract String description

Property placeholder in UI.

optional

public abstract boolean optional

Is the value mandatory and must be filled?.

Default:

false

fromServer

public abstract boolean fromServer

Property can be configured only from environment.

Default:

false

forTemplate

public abstract boolean forTemplate

Is the property can be configured on template?.

Default:

false

forServer

public abstract boolean forServer

Is the property can be configured on server?.

Default:

true

forTrigger

public abstract boolean forTrigger

Is the property can be configured on trigger?.

Default:

true

isDynamic

public abstract boolean isDynamic

It's mean that property would be processed by TemplateEngine.

Default:

false

isRedefined

public abstract boolean isRedefined

TODO: Add JavaDoc.

Default:

false

loadTemplate

public abstract boolean loadTemplate

Loading template by ID.

Default:

false

userSettings

public abstract boolean userSettings

Create modifications from user configuration like envs.

Default:

false

order

public abstract int order

TODO: Add JavaDoc.

Default:

1

fileDirectoryType

public abstract String fileDirectoryType

TODO: Add JavaDoc.

Default:

""

uiCategory

public abstract String uiCategory

The category of the parameter to be displayed on the UI.

Default:

""

validatePattern

public abstract String validatePattern

Expression that is used to validate the property on the UI.

Default:

""