com.segue.scc.published.api.common82

Interface Property

All Known Implementing Classes:

DefaultProperty

public interface Property

Properties are used to enable generic configuration systems for code that is not exactly known at compile time. This is especially true for plug-ins. So this enables a plug-in to be configured with special properties via the GUI. DefaultProperty provides a default implementation for this interface. It simply provides bean setters for the required interface methods.

Since:

10.05.2006

Field Summary

Fields

Modifier and Type	Field and Description
static int	PROPERTY_TYPE_DIRECTORY Same as for file.
static int	PROPERTY_TYPE_DYNAMIC_EMUNERATION This type allows to provide a list with selectable values and the user has to choose exactly one of them.
static int	PROPERTY_TYPE_DYNAMIC_EMUNERATION_MULTI This type allows to provide a list with multiple selectable values and the user can choose some (or none) of them.
static java.lang.String	PROPERTY_TYPE_DYNAMIC_EMUNERATION_MULTI_SEPARATOR
static int	PROPERTY_TYPE_FILE This will be shown as text field.
static int	PROPERTY_TYPE_NUMBER This will be shown as text field.
static int	PROPERTY_TYPE_PASSWORD This will be shown as a password field.
static int	PROPERTY_TYPE_STATIC_EMUNERATION This type allows to provide a list with selectable values and the user has to choose exactly one of them.
static int	PROPERTY_TYPE_STRING This will be shown as text field.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultValue() Get the default value for a property, if nothing is set yet.
Property[]	getDependentProperties() Get all dependent properties for this property.
java.lang.String	getName() Get the unique name of the property.
int	getPropertyType() Get the type of a property.
IdentifiedObject[]	getValues() This is only relevant if the type is either PROPERTY_TYPE_STATIC_EMUNERATION or PROPERTY_TYPE_DYNAMIC_EMUNERATION.

Field Detail

PROPERTY_TYPE_NUMBER

static final int PROPERTY_TYPE_NUMBER

This will be shown as text field. The submitted value will be checked to be a number.

See Also:

Constant Field Values

PROPERTY_TYPE_STRING

static final int PROPERTY_TYPE_STRING

This will be shown as text field.

See Also:

Constant Field Values

PROPERTY_TYPE_PASSWORD

static final int PROPERTY_TYPE_PASSWORD

This will be shown as a password field. Passwords differ from strings as they are obfuscated in the GUI and encrypted in the database. This happens transparently for the plug-in, so it doesn't need to care about en-/decryption.

See Also:

Constant Field Values

PROPERTY_TYPE_FILE

static final int PROPERTY_TYPE_FILE

This will be shown as text field. Might be shown with a 'Browse' button in future versions.

See Also:

Constant Field Values

PROPERTY_TYPE_DIRECTORY

static final int PROPERTY_TYPE_DIRECTORY

Same as for file.

See Also:

Constant Field Values

PROPERTY_TYPE_STATIC_EMUNERATION

static final int PROPERTY_TYPE_STATIC_EMUNERATION

This type allows to provide a list with selectable values and the user has to choose exactly one of them. Properties with this type have to implement getValues() to provide the selectable values.

See Also:

Constant Field Values

PROPERTY_TYPE_DYNAMIC_EMUNERATION

static final int PROPERTY_TYPE_DYNAMIC_EMUNERATION

This type allows to provide a list with selectable values and the user has to choose exactly one of them. Additionally, a 'Load property' button is shown above the drop down list. This field type should be used if the selectable values depend on other properties. For example the values for property 'project' can't be loaded until the host and port of the issue tracking system are entered.

See Also:

Constant Field Values

PROPERTY_TYPE_DYNAMIC_EMUNERATION_MULTI

static final int PROPERTY_TYPE_DYNAMIC_EMUNERATION_MULTI

This type allows to provide a list with multiple selectable values and the user can choose some (or none) of them. Additionally, a 'Load property' button is shown above the list box. This field type should be used if the selectable values depend on other properties. For example the values for property 'project' can't be loaded until the host and port of the issue tracking system are entered.

See Also:

Constant Field Values

PROPERTY_TYPE_DYNAMIC_EMUNERATION_MULTI_SEPARATOR

static final java.lang.String PROPERTY_TYPE_DYNAMIC_EMUNERATION_MULTI_SEPARATOR

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Get the unique name of the property.

getDefaultValue

java.lang.String getDefaultValue()

Get the default value for a property, if nothing is set yet. If this method returns null, there is no default value.

Returns:

the default value for a property, if nothing is set yet. null, if there is no default value

getValues

IdentifiedObject[] getValues()
                      throws java.lang.Exception

This is only relevant if the type is either PROPERTY_TYPE_STATIC_EMUNERATION or PROPERTY_TYPE_DYNAMIC_EMUNERATION.

Returns:

possible values for this property

Throws:

java.lang.Exception

See Also:

IdentifiedObject

getPropertyType

int getPropertyType()

Get the type of a property. See the PROPERTY_TYPE_* constants in the interface for valid property types.

Returns:

the type of a property

getDependentProperties

Property[] getDependentProperties()

Get all dependent properties for this property. If this method returns null, there are no dependent properties. These instances of dependent properties must be the same as the properties returned by the getPropertyObjects() of the EnhancedPropertyProvider interface.

Returns:

array of dependent properties. null, if no depended properties exist.