com.microfocus.da.sct.annotations

Annotation Type SourceConfigTypeParam

@Inherited
 @Target(value=FIELD)
 @Retention(value=RUNTIME)
public @interface SourceConfigTypeParam

Define the set of parameters for an external source configuration type. These are used during component creation to configure the source configuration type fields.

Author:

Serena Software, Inc., a Micro Focus Company

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description Description of the parameter
String	displayName User defined display name of the parameter

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
AllowedValue[]	allowedValues Defines the set of allowed values for this parameter
DataType	dataType Data type of the parameter
String	defaultValue What is the default value of this parameter?
boolean	hidden Does this parameter need to be hidden?
boolean	readOnly Does this parameter need to be read only? If this is set to true, it is treated as read only.
boolean	required Is this parameter required?

Element Detail

displayName

public abstract String displayName

User defined display name of the parameter

Returns:

Display name

description

public abstract String description

Description of the parameter

Returns:

Description

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

Defines the set of allowed values for this parameter

Returns:

Array of allowed values

Default:

{}

hidden

public abstract boolean hidden

Does this parameter need to be hidden?

Returns:

true if it should be hidden

Default:

false

readOnly

public abstract boolean readOnly

Does this parameter need to be read only? If this is set to true, it is treated as read only. If it is set to false, if a value is entered during source configuration type configuration, the value is persisted in the database.

Returns:

true if it is read only

Default:

true

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 this parameter

Default:

""