com.microfocus.da.sct.annotations

Annotation Type VersionParam

@Inherited
 @Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface VersionParam

Defines a set of version parameters for external source configuration types. This is used during runtime to get a version for a component.

Author:

Serena Software, Inc., a Micro Focus Company

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name Name of the versionParam property

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
AllowedValue[]	allowedValues Set of allowed values for this parameter
DataType	dataType Data type of the parameter
String	defaultValue What is the default value of this parameter?
String	description Description of the parameter
String	displayName Display name of this parameter
boolean	required Is this parameter required?

Element Detail

name

public abstract String name

Name of the versionParam property

Returns:

Name

displayName

public abstract String displayName

Display name of this parameter

Returns:

Display name

Default:

""

description

public abstract String description

Description of the parameter

Returns:

Description

Default:

""

dataType

public abstract DataType dataType

Data type of the parameter

Returns:

DataType

Default:

com.microfocus.da.sct.annotations.DataType.TEXT

allowedValues

public abstract AllowedValue[] allowedValues

Set of allowed values for this parameter

Returns:

Array of allowed values

Default:

{}

required

public abstract boolean required

Is this parameter required?

Returns:

true if it is required

Default:

false

defaultValue

public abstract String defaultValue

What is the default value of this parameter?

Returns:

Default value of the parameter

Default:

""